Skip to content

feat: add support for template version messages in api and cli #8336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jul 11, 2023
Merged

feat: add support for template version messages in api and cli #8336

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
77dbe0b
add migrations
mafredri Jul 6, 2023
f40bcc7
propagate message in api response
mafredri Jul 6, 2023
a2aedfd
feat(cli): add template version message
mafredri Jul 6, 2023
ffb7f3f
fixup! propagate message in api response
mafredri Jul 6, 2023
98377ad
make gen
mafredri Jul 6, 2023
960e5d1
update golden files
mafredri Jul 6, 2023
7cd20bb
Merge branch 'main' into mafredri/feat-add-template-push-message
mafredri Jul 6, 2023
93de18a
detect newlines
mafredri Jul 6, 2023
5bee51f
limit message length
mafredri Jul 6, 2023
9280af6
fix
mafredri Jul 6, 2023
b8e36f6
Merge branch 'main' into mafredri/feat-add-template-push-message
mafredri Jul 10, 2023
9945e94
fix migration
mafredri Jul 11, 2023
3329d5b
Merge branch 'main' into mafredri/feat-add-template-push-message
mafredri Jul 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
make gen
  • Loading branch information
@mafredri
mafredri committed Jul 6, 2023
commit 98377ad533aaeb01f707d10aeff60b392bcd1656
6 changes: 6 additions & 0 deletions coderd/apidoc/docs.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions coderd/apidoc/swagger.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions docs/api/schemas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1435,6 +1435,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
{
"example_id": "string",
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"message": "string",
"name": "string",
"provisioner": "terraform",
"storage_method": "file",
Expand All @@ -1458,6 +1459,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
| ---------------------- | ---------------------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------ |
| `example_id` | string | false | | |
| `file_id` | string | false | | |
| `message` | string | false | | |
| `name` | string | false | | |
| `provisioner` | string | true | | |
| `storage_method` | [codersdk.ProvisionerStorageMethod](#codersdkprovisionerstoragemethod) | true | | |
Expand Down Expand Up @@ -4148,6 +4150,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
},
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
"message": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"readme": "string",
Expand All @@ -4165,6 +4168,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
| `created_by` | [codersdk.User](#codersdkuser) | false | | |
| `id` | string | false | | |
| `job` | [codersdk.ProvisionerJob](#codersdkprovisionerjob) | false | | |
| `message` | string | false | | |
| `name` | string | false | | |
| `organization_id` | string | false | | |
| `readme` | string | false | | |
Expand Down
10 changes: 10 additions & 0 deletions docs/api/templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
},
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
"message": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"readme": "string",
Expand Down Expand Up @@ -469,6 +470,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
},
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
"message": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"readme": "string",
Expand Down Expand Up @@ -506,6 +508,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa
{
"example_id": "string",
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"message": "string",
"name": "string",
"provisioner": "terraform",
"storage_method": "file",
Expand Down Expand Up @@ -572,6 +575,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa
},
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
"message": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"readme": "string",
Expand Down Expand Up @@ -875,6 +879,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions \
},
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
"message": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"readme": "string",
Expand Down Expand Up @@ -927,6 +932,7 @@ Status Code **200**
| `»» tags` | object | false | | |
| `»»» [any property]` | string | false | | |
| `»» worker_id` | string(uuid) | false | | |
| `» message` | string | false | | |
| `» name` | string | false | | |
| `» organization_id` | string(uuid) | false | | |
| `» readme` | string | false | | |
Expand Down Expand Up @@ -1068,6 +1074,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions/{templ
},
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
"message": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"readme": "string",
Expand Down Expand Up @@ -1120,6 +1127,7 @@ Status Code **200**
| `»» tags` | object | false | | |
| `»»» [any property]` | string | false | | |
| `»» worker_id` | string(uuid) | false | | |
| `» message` | string | false | | |
| `» name` | string | false | | |
| `» organization_id` | string(uuid) | false | | |
| `» readme` | string | false | | |
Expand Down Expand Up @@ -1205,6 +1213,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion} \
},
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
"message": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"readme": "string",
Expand Down Expand Up @@ -1293,6 +1302,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}
},
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
"message": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"readme": "string",
Expand Down
8 changes: 8 additions & 0 deletions docs/cli/templates_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,14 @@ Ignore warnings about not having a .terraform.lock.hcl file present in the templ

Specify an inactivity TTL for workspaces created from this template. This licensed feature's default is 0h (off).

### -m, --message

| | |
| ---- | ------------------- |
| Type | <code>string</code> |

Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.

### --private

| | |
Expand Down
8 changes: 8 additions & 0 deletions docs/cli/templates_push.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ Specify the directory to create from, use '-' to read tar from stdin.

Ignore warnings about not having a .terraform.lock.hcl file present in the template.

### -m, --message

| | |
| ---- | ------------------- |
| Type | <code>string</code> |

Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.

### --name

| | |
Expand Down