coder · BrunoQuaresma · Jul 13, 2023 · Jul 11, 2023 · Jul 11, 2023 · Jul 12, 2023
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbfake/dbfake.go b/coderd/database/dbfake/dbfake.go
@@ -4771,6 +4771,7 @@ func (q *FakeQuerier) UpdateTemplateVersionByID(_ context.Context, arg database.
 		templateVersion.TemplateID = arg.TemplateID
 		templateVersion.UpdatedAt = arg.UpdatedAt
 		templateVersion.Name = arg.Name
+		templateVersion.Message = arg.Message
 		q.templateVersions[index] = templateVersion
 		return templateVersion, nil
 	}

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
@@ -91,7 +91,8 @@ UPDATE
 SET
 	template_id = $2,
 	updated_at = $3,
-	name = $4
+	name = $4,
+	message = $5
 WHERE
 	id = $1 RETURNING *;
 

diff --git a/coderd/templates.go b/coderd/templates.go
@@ -336,6 +336,7 @@ func (api *API) postTemplateByOrganization(rw http.ResponseWriter, r *http.Reque
 			},
 			UpdatedAt: database.Now(),
 			Name:      templateVersion.Name,
+			Message:   templateVersion.Message,
 		})
 		if err != nil {
 			return xerrors.Errorf("insert template version: %s", err)

diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -106,12 +106,17 @@ func (api *API) patchTemplateVersion(rw http.ResponseWriter, r *http.Request) {
 		TemplateID: templateVersion.TemplateID,
 		UpdatedAt:  database.Now(),
 		Name:       templateVersion.Name,
+		Message:    templateVersion.Message,
 	}
 
 	if params.Name != "" {
 		updateParams.Name = params.Name
 	}
 
+	if params.Message != nil {
+		updateParams.Message = *params.Message
+	}
+
 	errTemplateVersionNameConflict := xerrors.New("template version name must be unique for a template")
 
 	var updatedTemplateVersion database.TemplateVersion

diff --git a/coderd/templateversions_test.go b/coderd/templateversions_test.go
@@ -1223,6 +1223,71 @@ func TestTemplateVersionPatch(t *testing.T) {
 		assert.NotEqual(t, updatedVersion.Name, version.Name)
 	})
 
+	t.Run("Update the message", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		user := coderdtest.CreateFirstUser(t, client)
+		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil, func(req *codersdk.CreateTemplateVersionRequest) {
+			req.Message = "Example message"
+		})
+		coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancel()
+
+		wantMessage := "Updated message"
+		updatedVersion, err := client.UpdateTemplateVersion(ctx, version.ID, codersdk.PatchTemplateVersionRequest{
+			Message: &wantMessage,
+		})
+
+		require.NoError(t, err)
+		assert.Equal(t, wantMessage, updatedVersion.Message)
+	})
+
+	t.Run("Remove the message", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		user := coderdtest.CreateFirstUser(t, client)
+		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil, func(req *codersdk.CreateTemplateVersionRequest) {
+			req.Message = "Example message"
+		})
+		coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancel()
+
+		wantMessage := ""
+		updatedVersion, err := client.UpdateTemplateVersion(ctx, version.ID, codersdk.PatchTemplateVersionRequest{
+			Message: &wantMessage,
+		})
+
+		require.NoError(t, err)
+		assert.Equal(t, wantMessage, updatedVersion.Message)
+	})
+
+	t.Run("Keep the message", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		user := coderdtest.CreateFirstUser(t, client)
+		wantMessage := "Example message"
+		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil, func(req *codersdk.CreateTemplateVersionRequest) {
+			req.Message = wantMessage
+		})
+		coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
+
+		t.Log(version.Message)
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancel()
+
+		updatedVersion, err := client.UpdateTemplateVersion(ctx, version.ID, codersdk.PatchTemplateVersionRequest{
+			Message: nil,
+		})
+
+		require.NoError(t, err)
+		assert.Equal(t, wantMessage, updatedVersion.Message)
+	})
+
 	t.Run("Use the same name if a new name is not passed", func(t *testing.T) {
 		t.Parallel()
 		client := coderdtest.New(t, nil)

diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -87,7 +87,8 @@ type TemplateVersionVariable struct {
 }
 
 type PatchTemplateVersionRequest struct {
-	Name string `json:"name" validate:"omitempty,template_version_name"`
+	Name    string  `json:"name" validate:"omitempty,template_version_name"`
+	Message *string `json:"message,omitempty" validate:"omitempty,lt=1048577"`
 }
 
 // TemplateVersion returns a template version by ID.

diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -3226,15 +3226,17 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
 
 ```json
 {
+  "message": "string",
   "name": "string"
 }
 ```
 
 ### Properties
 
-| Name   | Type   | Required | Restrictions | Description |
-| ------ | ------ | -------- | ------------ | ----------- |
-| `name` | string | false    |              |             |
+| Name      | Type   | Required | Restrictions | Description |
+| --------- | ------ | -------- | ------------ | ----------- |
+| `message` | string | false    |              |             |
+| `name`    | string | false    |              |             |
 
 ## codersdk.PatchWorkspaceProxy
 

diff --git a/docs/api/templates.md b/docs/api/templates.md
@@ -1249,6 +1249,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}
 
 ```json
 {
+  "message": "string",
   "name": "string"
 }
 ```

diff --git a/site/.storybook/preview.jsx b/site/.storybook/preview.jsx
@@ -5,6 +5,7 @@ import { HelmetProvider } from "react-helmet-async"
 import { dark } from "../src/theme"
 import "../src/theme/globalFonts"
 import "../src/i18n"
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query"
 
 export const decorators = [
   (Story) => (
@@ -23,6 +24,13 @@ export const decorators = [
       </HelmetProvider>
     )
   },
+  (Story) => {
+    return (
+      <QueryClientProvider client={new QueryClient()}>
+        <Story />
+      </QueryClientProvider>
+    )
+  },
 ]
 
 export const parameters = {

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -644,6 +644,7 @@ export interface PatchGroupRequest {
 // From codersdk/templateversions.go
 export interface PatchTemplateVersionRequest {
   readonly name: string
+  readonly message?: string
 }
 
 // From codersdk/workspaceproxy.go

diff --git a/site/src/components/TemplateVersionEditor/PublishTemplateVersionDialog.tsx b/site/src/components/TemplateVersionEditor/PublishTemplateVersionDialog.tsx
@@ -32,10 +32,12 @@ export const PublishTemplateVersionDialog: FC<
   const form = useFormik({
     initialValues: {
       name: defaultName,
+      message: "",
       isActiveVersion: false,
     },
     validationSchema: Yup.object({
       name: Yup.string().required(),
+      message: Yup.string(),
       isActiveVersion: Yup.boolean(),
     }),
     onSubmit: onConfirm,
@@ -70,6 +72,16 @@ export const PublishTemplateVersionDialog: FC<
               disabled={isPublishing}
             />
 
+            <TextField
+              {...getFieldHelpers("message")}
+              label="Message"
+              placeholder="Write a short message about the changes you made..."
+              autoFocus
+              disabled={isPublishing}
+              multiline
+              rows={5}
+            />
+
             <FormControlLabel
               label="Promote to default version"
               control={

diff --git a/site/src/components/Tooltips/OutdatedHelpTooltip.tsx b/site/src/components/Tooltips/OutdatedHelpTooltip.tsx
-Original file line number
+Diff line change
@@ Expand Up @@
     ```json
     {
+      "message": "string",
       "name": "string"
     }
     ```
@@ Expand Down @@