Skip to content

Commit 759b362

Browse files
coadlercoadler
committed
description -> readme
1 parent db92f72 commit 759b362

File tree

13 files changed

+44
-43
lines changed

13 files changed

+44
-43
lines changed

‎coderd/database/databasefake/databasefake.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1190,7 +1190,7 @@ func (q *fakeQuerier) InsertTemplateVersion(_ context.Context, arg database.Inse
11901190
CreatedAt: arg.CreatedAt,
11911191
UpdatedAt: arg.UpdatedAt,
11921192
Name: arg.Name,
1193-
Description: arg.Description,
1193+
Readme: arg.Readme,
11941194
JobID: arg.JobID,
11951195
}
11961196
q.templateVersions = append(q.templateVersions, version)
@@ -1528,7 +1528,7 @@ func (q *fakeQuerier) UpdateTemplateVersionDescriptionByJobID(_ context.Context,
15281528
if templateVersion.JobID != arg.JobID {
15291529
continue
15301530
}
1531-
templateVersion.Description = arg.Description
1531+
templateVersion.Readme = arg.Readme
15321532
templateVersion.UpdatedAt = time.Now()
15331533
q.templateVersions[index] = templateVersion
15341534
return nil

‎coderd/database/dump.sql

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/database/migrations/000012_template_version_readme.down.sql

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ALTER TABLE template_versions RENAME README TO description;

‎coderd/database/migrations/000012_template_version_readme.up.sql

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ALTER TABLE template_versions RENAME description TO readme;

‎coderd/database/models.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/database/queries.sql.go

Lines changed: 17 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/database/queries/templateversions.sql

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ INSERT INTO
6666
created_at,
6767
updated_at,
6868
"name",
69-
description,
69+
readme,
7070
job_id
7171
)
7272
VALUES
@@ -85,7 +85,7 @@ WHERE
8585
UPDATE
8686
template_versions
8787
SET
88-
description = $2,
88+
readme = $2,
8989
updated_at = now()
9090
WHERE
9191
job_id = $1;

‎coderd/provisionerdaemons.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -350,8 +350,8 @@ func (server *provisionerdServer) UpdateJob(ctx context.Context, request *proto.
350350

351351
if len(request.Readme) > 0 {
352352
err := server.Database.UpdateTemplateVersionDescriptionByJobID(ctx, database.UpdateTemplateVersionDescriptionByJobIDParams{
353-
JobID: job.ID,
354-
Description: string(request.Readme),
353+
JobID: job.ID,
354+
Readme: string(request.Readme),
355355
})
356356
if err != nil {
357357
return nil, xerrors.Errorf("update template version description: %w", err)

‎coderd/templateversions.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ func (api *api) postTemplateVersionsByOrganization(rw http.ResponseWriter, r *ht
357357
CreatedAt: database.Now(),
358358
UpdatedAt: database.Now(),
359359
Name: namesgenerator.GetRandomName(1),
360-
Description: "",
360+
Readme: "",
361361
JobID: provisionerJob.ID,
362362
})
363363
if err != nil {
@@ -401,12 +401,12 @@ func (api *api) templateVersionLogs(rw http.ResponseWriter, r *http.Request) {
401401

402402
func convertTemplateVersion(version database.TemplateVersion, job codersdk.ProvisionerJob) codersdk.TemplateVersion {
403403
return codersdk.TemplateVersion{
404-
ID: version.ID,
405-
TemplateID: &version.TemplateID.UUID,
406-
CreatedAt: version.CreatedAt,
407-
UpdatedAt: version.UpdatedAt,
408-
Name: version.Name,
409-
Job: job,
410-
Description: version.Description,
404+
ID: version.ID,
405+
TemplateID: &version.TemplateID.UUID,
406+
CreatedAt: version.CreatedAt,
407+
UpdatedAt: version.UpdatedAt,
408+
Name: version.Name,
409+
Job: job,
410+
Readme: version.Readme,
411411
}
412412
}

‎codersdk/templateversions.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ import (
1515

1616
// TemplateVersion represents a single version of a template.
1717
type TemplateVersion struct {
18-
ID uuid.UUID `json:"id"`
19-
TemplateID *uuid.UUID `json:"template_id,omitempty"`
20-
CreatedAt time.Time `json:"created_at"`
21-
UpdatedAt time.Time `json:"updated_at"`
22-
Name string `json:"name"`
23-
Job ProvisionerJob `json:"job"`
24-
Description string `json:"description"`
18+
ID uuid.UUID `json:"id"`
19+
TemplateID *uuid.UUID `json:"template_id,omitempty"`
20+
CreatedAt time.Time `json:"created_at"`
21+
UpdatedAt time.Time `json:"updated_at"`
22+
Name string `json:"name"`
23+
Job ProvisionerJob `json:"job"`
24+
Readme string `json:"readme"`
2525
}
2626

2727
// TemplateVersionParameterSchema represents a parameter parsed from template version source.

‎provisioner/echo/serve.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import (
99
"path/filepath"
1010

1111
"golang.org/x/xerrors"
12-
1312
protobuf "google.golang.org/protobuf/proto"
1413

1514
"github.com/coder/coder/provisionersdk"

‎provisionerd/provisionerd_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ func TestProvisionerd(t *testing.T) {
232232
Provisioner: "someprovisioner",
233233
TemplateSourceArchive: createTar(t, map[string]string{
234234
"test.txt": "content",
235-
provisionerd.ReadmeFile: "# A cool template 😎",
235+
provisionerd.ReadmeFile: "# A cool template 😎\n",
236236
}),
237237
Type: &proto.AcquiredJob_TemplateImport_{
238238
TemplateImport: &proto.AcquiredJob_TemplateImport{

‎site/src/api/typesGenerated.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ export interface TemplateVersion {
231231
readonly updated_at: string
232232
readonly name: string
233233
readonly job: ProvisionerJob
234-
readonly description: string
234+
readonly readme: string
235235
}
236236

237237
// From codersdk/templateversions.go:31:6

0 commit comments

Comments
 (0)