Skip to content

Commit aea7b50

Browse files
committed
fixes
1 parent 972a26f commit aea7b50

File tree

8 files changed

+11
-11
lines changed

8 files changed

+11
-11
lines changed

docs/data-sources/git_auth.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "coder_git_auth Data Source - terraform-provider-coder"
44
subcategory: ""
55
description: |-
6-
Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated git clone in startup scripts.
6+
Deprecated: use the coder_external_auth data source instead. Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated git clone in startup scripts.
77
---
88

99
# coder_git_auth (Data Source)
1010

11-
Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.
11+
**Deprecated**: use the `coder_external_auth` data source instead. Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.
1212

1313
## Example Usage
1414

docs/data-sources/parameter.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ data "coder_parameter" "home_volume_size" {
149149
- `mutable` (Boolean) Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
150150
- `option` (Block List, Max: 64) Each `option` block defines a value for a user to select from. (see [below for nested schema](#nestedblock--option))
151151
- `order` (Number) The order determines the position of a template parameter in the UI/CLI presentation. The lowest order is shown first and parameters with equal order are sorted by name (ascending order).
152-
- `type` (String) The type of this parameter. Must be one of: `number`, `string`, `bool`, or `list(string)`.
152+
- `type` (String) The type of this parameter. Must be one of: `"number"`, `"string"`, `"bool"`, or `"list(string)"`.
153153
- `validation` (Block List, Max: 1) Validate the input of a parameter. (see [below for nested schema](#nestedblock--validation))
154154

155155
### Read-Only
@@ -169,7 +169,7 @@ Required:
169169
Optional:
170170

171171
- `description` (String) Describe what selecting this value does.
172-
- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + "/icon/<path>"`.
172+
- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons [here](https://github.com/coder/coder/tree/main/site/static/icon). Use a built-in icon with `"${data.coder_workspace.me.access_url}/icon/<path>"`.
173173

174174

175175
<a id="nestedblock--validation"></a>

docs/resources/metadata.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ resource "coder_metadata" "pod_info" {
6565

6666
- `daily_cost` (Number) (Enterprise) The cost of this resource every 24 hours. Use the smallest denomination of your preferred currency. For example, if you work in USD, use cents.
6767
- `hide` (Boolean) Hide the resource from the UI.
68-
- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + "/icon/<path>"`.
68+
- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons [here](https://github.com/coder/coder/tree/main/site/static/icon). Use a built-in icon with `"${data.coder_workspace.me.access_url}/icon/<path>"`.
6969
- `item` (Block List) Each `item` block defines a single metadata item consisting of a key/value pair. (see [below for nested schema](#nestedblock--item))
7070

7171
### Read-Only

docs/resources/script.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ resource "coder_script" "shutdown" {
7979
### Optional
8080

8181
- `cron` (String) The cron schedule to run the script on. This is a cron expression.
82-
- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + "/icon/<path>"`.
82+
- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons [here](https://github.com/coder/coder/tree/main/site/static/icon). Use a built-in icon with `"${data.coder_workspace.me.access_url}/icon/<path>"`.
8383
- `log_path` (String) The path of a file to write the logs to. If relative, it will be appended to tmp.
8484
- `run_on_start` (Boolean) This option defines whether or not the script should run when the agent starts. The script should exit when it is done to signal that the agent is ready.
8585
- `run_on_stop` (Boolean) This option defines whether or not the script should run when the agent stops. The script should exit when it is done to signal that the workspace can be stopped.

provider/app.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ func appResource() *schema.Resource {
8484
}
8585

8686
if !appSlugRegex.MatchString(valStr) {
87-
return diag.Errorf("invalid \"coder_app\" slug, must be a valid hostname (%q, cannot contain two consecutive hyphens or start/end with a hyphen): %q", appSlugRegex.String(), valStr)
87+
return diag.Errorf(`invalid "coder_app" slug, must be a valid hostname (%q, cannot contain two consecutive hyphens or start/end with a hyphen): %q`, appSlugRegex.String(), valStr)
8888
}
8989

9090
return nil

provider/gitauth.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ func gitAuthDataSource() *schema.Resource {
1616
SchemaVersion: 1,
1717

1818
DeprecationMessage: "Use the `coder_external_auth` data source instead.",
19-
Description: "Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.",
19+
Description: "**Deprecated**: use the `coder_external_auth` data source instead. Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.",
2020
ReadContext: func(ctx context.Context, rd *schema.ResourceData, i interface{}) diag.Diagnostics {
2121
rawID, ok := rd.GetOk("id")
2222
if !ok {

provider/parameter.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ func parameterDataSource() *schema.Resource {
204204
Default: "string",
205205
Optional: true,
206206
ValidateFunc: validation.StringInSlice([]string{"number", "string", "bool", "list(string)"}, false),
207-
Description: "The type of this parameter. Must be one of: `number`, `string`, `bool`, or `list(string)`.",
207+
Description: "The type of this parameter. Must be one of: `\"number\"`, `\"string\"`, `\"bool\"`, or `\"list(string)\"`.",
208208
},
209209
"mutable": {
210210
Type: schema.TypeBool,

provider/script_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ func TestScriptNeverRuns(t *testing.T) {
6969
script = "Wow"
7070
}
7171
`,
72-
ExpectError: regexp.MustCompile("at least one of \"run_on_start\", \"run_on_stop\", or \"cron\" must be set"),
72+
ExpectError: regexp.MustCompile(`at least one of "run_on_start", "run_on_stop", or "cron" must be set`),
7373
}},
7474
})
7575
}
@@ -94,7 +94,7 @@ func TestScriptStartBlocksLoginRequiresRunOnStart(t *testing.T) {
9494
start_blocks_login = true
9595
}
9696
`,
97-
ExpectError: regexp.MustCompile("\"start_blocks_login\" can only be set if \"run_on_start\" is \"true\""),
97+
ExpectError: regexp.MustCompile(`"start_blocks_login" can only be set if "run_on_start" is "true"`),
9898
}},
9999
})
100100
resource.Test(t, resource.TestCase{

0 commit comments

Comments
 (0)