Add base

coder · BrunoQuaresma · Jul 13, 2023 · Jul 11, 2023 · Jul 11, 2023 · Jul 12, 2023
commit 5bc48df3dced414f7511ecd1f108d289dbe0db75
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/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/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 != "" {
+		updateParams.Message = params.Message
+	}
+
 	errTemplateVersionNameConflict := xerrors.New("template version name must be unique for a template")
 
 	var updatedTemplateVersion database.TemplateVersion

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" validate:"omitempty"`
 }
 
 // TemplateVersion returns a template version by ID.

diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -3222,15 +3222,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/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/...mponents/Tooltips/OutdatedHelpTooltip.tsx → ...nts/Tooltips/WorkspaceOutdatedTooltip.tsx b/...mponents/Tooltips/OutdatedHelpTooltip.tsx → ...nts/Tooltips/WorkspaceOutdatedTooltip.tsx
@@ -23,10 +23,9 @@ interface TooltipProps {
   ariaLabel?: string
 }
 
-export const OutdatedHelpTooltip: FC<React.PropsWithChildren<TooltipProps>> = ({
-  onUpdateVersion,
-  ariaLabel,
-}) => {
+export const WorkspaceOutdatedTooltip: FC<
+  React.PropsWithChildren<TooltipProps>
+> = ({ onUpdateVersion, ariaLabel }) => {
   const styles = useStyles()
 
   return (

diff --git a/site/src/components/Tooltips/index.ts b/site/src/components/Tooltips/index.ts
@@ -1,4 +1,4 @@
 export { AuditHelpTooltip } from "./AuditHelpTooltip"
-export { OutdatedHelpTooltip } from "./OutdatedHelpTooltip"
+export { WorkspaceOutdatedTooltip } from "./WorkspaceOutdatedTooltip"
 export { UserRoleHelpTooltip } from "./UserRoleHelpTooltip"
 export { WorkspaceHelpTooltip } from "./WorkspaceHelpTooltip"
diff --git a/site/src/components/WorkspaceStats/WorkspaceStats.tsx b/site/src/components/WorkspaceStats/WorkspaceStats.tsx
@@ -1,5 +1,5 @@
 import Link from "@mui/material/Link"
-import { OutdatedHelpTooltip } from "components/Tooltips"
+import { WorkspaceOutdatedTooltip } from "components/Tooltips"
 import { FC, useRef, useState } from "react"
 import { Link as RouterLink } from "react-router-dom"
 import { createDayString } from "utils/createDayString"
@@ -101,7 +101,7 @@ export const WorkspaceStats: FC<WorkspaceStatsProps> = ({
               </Link>
 
               {workspace.outdated && (
-                <OutdatedHelpTooltip
+                <WorkspaceOutdatedTooltip
                   onUpdateVersion={handleUpdate}
                   ariaLabel="update version"
                 />

diff --git a/site/src/components/WorkspacesTable/WorkspacesRow.tsx b/site/src/components/WorkspacesTable/WorkspacesRow.tsx
@@ -9,7 +9,7 @@ import { useNavigate } from "react-router-dom"
 import { getDisplayWorkspaceTemplateName } from "utils/workspace"
 import { LastUsed } from "../LastUsed/LastUsed"
 import { Workspace } from "api/typesGenerated"
-import { OutdatedHelpTooltip } from "components/Tooltips/OutdatedHelpTooltip"
+import { WorkspaceOutdatedTooltip } from "components/Tooltips/WorkspaceOutdatedTooltip"
 import { Avatar } from "components/Avatar/Avatar"
 import { Stack } from "components/Stack/Stack"
 import { useClickableTableRow } from "hooks/useClickableTableRow"
@@ -34,7 +34,7 @@ export const WorkspacesRow: FC<{
             <Stack direction="row" spacing={0} alignItems="center">
               {workspace.name}
               {workspace.outdated && (
-                <OutdatedHelpTooltip
+                <WorkspaceOutdatedTooltip
                   onUpdateVersion={() => {
                     onUpdateWorkspace(workspace)
                   }}

diff --git a/site/src/pages/TemplateVersionPage/TemplateVersionEditorPage/types.ts b/site/src/pages/TemplateVersionPage/TemplateVersionEditorPage/types.ts
@@ -1,4 +1,5 @@
 export type PublishVersionData = {
   name: string
+  message: string
   isActiveVersion: boolean
 }
diff --git a/site/src/pages/TemplateVersionPage/TemplateVersionPageView.tsx b/site/src/pages/TemplateVersionPage/TemplateVersionPageView.tsx
@@ -6,6 +6,7 @@ import { Margins } from "components/Margins/Margins"
 import {
   PageHeader,
   PageHeaderCaption,
+  PageHeaderSubtitle,
   PageHeaderTitle,
 } from "components/PageHeader/PageHeader"
 import { Stack } from "components/Stack/Stack"
@@ -52,6 +53,11 @@ export const TemplateVersionPageView: FC<TemplateVersionPageViewProps> = ({
       >
         <PageHeaderCaption>{t("header.caption")}</PageHeaderCaption>
         <PageHeaderTitle>{versionName}</PageHeaderTitle>
+        {currentVersion &&
+          currentVersion.message &&
+          currentVersion.message !== "" && (
+            <PageHeaderSubtitle>{currentVersion.message}</PageHeaderSubtitle>
+          )}
       </PageHeader>
 
       {!currentFiles && !error && <Loader />}

diff --git a/site/src/xServices/templateVersionEditor/templateVersionEditorXService.ts b/site/src/xServices/templateVersionEditor/templateVersionEditorXService.ts
@@ -387,7 +387,7 @@ export const templateVersionEditorMachine = createMachine(
       },
       publishingVersion: async (
         { version, templateId },
-        { name, isActiveVersion },
+        { name, message, isActiveVersion },
       ) => {
         if (!version) {
           throw new Error("Version is not set")
@@ -398,7 +398,7 @@ export const templateVersionEditorMachine = createMachine(
         await Promise.all([
           // Only do a patch if the name is different
           name !== version.name
-            ? API.patchTemplateVersion(version.id, { name })
+            ? API.patchTemplateVersion(version.id, { name, message })
             : Promise.resolve(),
           isActiveVersion
             ? API.updateActiveTemplateVersion(templateId, {
-Original file line number
+Diff line change
@@ Expand Up @@
     ```json
     {
+      "message": "string",
       "name": "string"
     }
     ```
@@ Expand Down @@