description -> readme

coadler · coadler · commit b834d0b234aa · 2022-05-17T14:17:52.000-05:00
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000012_template_version_readme.down.sql b/coderd/database/migrations/000012_template_version_readme.down.sql
@@ -0,0 +1 @@
+ALTER TABLE template_versions RENAME README TO description;
diff --git a/coderd/database/migrations/000012_template_version_readme.up.sql b/coderd/database/migrations/000012_template_version_readme.up.sql
@@ -0,0 +1 @@
+ALTER TABLE template_versions RENAME description TO readme;
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/templateversions.sql b/coderd/database/queries/templateversions.sql
@@ -66,7 +66,7 @@ INSERT INTO
 		created_at,
 		updated_at,
 		"name",
-		description,
+		readme,
 		job_id
 	)
 VALUES
@@ -85,7 +85,7 @@ WHERE
 UPDATE
 	template_versions
 SET
-	description = $2,
+	readme = $2,
 	updated_at = now()
 WHERE
 	job_id = $1;
diff --git a/coderd/provisionerdaemons.go b/coderd/provisionerdaemons.go
@@ -350,8 +350,8 @@ func (server *provisionerdServer) UpdateJob(ctx context.Context, request *proto.
 
 	if len(request.Readme) > 0 {
 		err := server.Database.UpdateTemplateVersionDescriptionByJobID(ctx, database.UpdateTemplateVersionDescriptionByJobIDParams{
-			JobID:       job.ID,
-			Description: string(request.Readme),
+			JobID:  job.ID,
+			Readme: string(request.Readme),
 		})
 		if err != nil {
 			return nil, xerrors.Errorf("update template version description: %w", err)
diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -357,7 +357,7 @@ func (api *api) postTemplateVersionsByOrganization(rw http.ResponseWriter, r *ht
 			CreatedAt:      database.Now(),
 			UpdatedAt:      database.Now(),
 			Name:           namesgenerator.GetRandomName(1),
-			Description:    "",
+			Readme:         "",
 			JobID:          provisionerJob.ID,
 		})
 		if err != nil {
@@ -401,12 +401,12 @@ func (api *api) templateVersionLogs(rw http.ResponseWriter, r *http.Request) {
 
 func convertTemplateVersion(version database.TemplateVersion, job codersdk.ProvisionerJob) codersdk.TemplateVersion {
 	return codersdk.TemplateVersion{
-		ID:          version.ID,
-		TemplateID:  &version.TemplateID.UUID,
-		CreatedAt:   version.CreatedAt,
-		UpdatedAt:   version.UpdatedAt,
-		Name:        version.Name,
-		Job:         job,
-		Description: version.Description,
+		ID:         version.ID,
+		TemplateID: &version.TemplateID.UUID,
+		CreatedAt:  version.CreatedAt,
+		UpdatedAt:  version.UpdatedAt,
+		Name:       version.Name,
+		Job:        job,
+		Readme:     version.Readme,
 	}
 }
diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -15,13 +15,13 @@ import (
 
 // TemplateVersion represents a single version of a template.
 type TemplateVersion struct {
-	ID          uuid.UUID      `json:"id"`
-	TemplateID  *uuid.UUID     `json:"template_id,omitempty"`
-	CreatedAt   time.Time      `json:"created_at"`
-	UpdatedAt   time.Time      `json:"updated_at"`
-	Name        string         `json:"name"`
-	Job         ProvisionerJob `json:"job"`
-	Description string         `json:"description"`
+	ID         uuid.UUID      `json:"id"`
+	TemplateID *uuid.UUID     `json:"template_id,omitempty"`
+	CreatedAt  time.Time      `json:"created_at"`
+	UpdatedAt  time.Time      `json:"updated_at"`
+	Name       string         `json:"name"`
+	Job        ProvisionerJob `json:"job"`
+	Readme     string         `json:"readme"`
 }
 
 // TemplateVersionParameterSchema represents a parameter parsed from template version source.
diff --git a/provisioner/echo/serve.go b/provisioner/echo/serve.go
@@ -9,7 +9,6 @@ import (
 	"path/filepath"
 
 	"golang.org/x/xerrors"
-
 	protobuf "google.golang.org/protobuf/proto"
 
 	"github.com/coder/coder/provisionersdk"
diff --git a/provisionerd/provisionerd_test.go b/provisionerd/provisionerd_test.go
@@ -232,7 +232,7 @@ func TestProvisionerd(t *testing.T) {
 						Provisioner: "someprovisioner",
 						TemplateSourceArchive: createTar(t, map[string]string{
 							"test.txt":              "content",
-							provisionerd.ReadmeFile: "# A cool template 😎",
+							provisionerd.ReadmeFile: "# A cool template 😎\n",
 						}),
 						Type: &proto.AcquiredJob_TemplateImport_{
 							TemplateImport: &proto.AcquiredJob_TemplateImport{
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -231,7 +231,7 @@ export interface TemplateVersion {
   readonly updated_at: string
   readonly name: string
   readonly job: ProvisionerJob
-  readonly description: string
+  readonly readme: string
 }
 
 // From codersdk/templateversions.go:31:6

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE template_versions RENAME README TO description;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE template_versions RENAME description TO readme;`