Skip to content

Commit 7563690

Browse files
christopher-hakkaartchristopher-hakkaart
authored
Merge branch 'master' into chris-update-links
2 parents 1f445b3 + f83e8b7 commit 7563690

File tree

24 files changed

+249
-241
lines changed

24 files changed

+249
-241
lines changed

‎netlify.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
EXCLUDE_PLATFORM_OPENAPI="true"
2323

2424
# Asset and image routing handled by Edge Function
25-
# See .netlify/edge-functions/asset-proxy.js
25+
# See netlify/edge-functions/asset-proxy.js
2626
[[edge_functions]]
2727
function = "asset-proxy"
2828
path = "/assets/*"

‎platform-cli-docs/docs/reference/actions.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ List pipeline actions.
2020
tw actions list [OPTIONS]
2121
```
2222

23-
### Options
23+
#### Options
2424

2525
| Option | Description | Required | Default |
2626
|--------|-------------|----------|----------|
2727
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
2828

29-
### Example
29+
#### Example
3030

3131
Command:
3232

@@ -53,15 +53,15 @@ View pipeline action details.
5353
tw actions view [OPTIONS]
5454
```
5555

56-
### Options
56+
#### Options
5757

5858
| Option | Description | Required | Default |
5959
|--------|-------------|----------|----------|
6060
| `-i`, `--id` | Action unique identifier | No | `null` |
6161
| `-n`, `--name` | Action name | No | `null` |
6262
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
6363

64-
### Example
64+
#### Example
6565

6666
Command:
6767

@@ -122,7 +122,7 @@ Supported event sources:
122122
- **github**: GitHub webhook events (push, pull request, etc.)
123123
:::
124124

125-
### Options
125+
#### Options
126126

127127
| Option | Description | Required | Default |
128128
|--------|-------------|----------|----------|
@@ -146,7 +146,7 @@ Supported event sources:
146146
| `--user-secrets` | Array of user secrets to make available to the pipeline. | No | `null` |
147147
| `--workspace-secrets` | Array of workspace secrets to make available to the pipeline. | No | `null` |
148148

149-
### Example
149+
#### Example
150150

151151
Command:
152152

@@ -172,7 +172,7 @@ Update a pipeline action.
172172
tw actions update [OPTIONS]
173173
```
174174

175-
### Options
175+
#### Options
176176

177177
| Option | Description | Required | Default |
178178
|--------|-------------|----------|----------|
@@ -197,7 +197,7 @@ tw actions update [OPTIONS]
197197
| `--user-secrets` | Array of user secrets to make available to the pipeline. | No | `null` |
198198
| `--workspace-secrets` | Array of workspace secrets to make available to the pipeline. | No | `null` |
199199

200-
### Example
200+
#### Example
201201

202202
Command:
203203

@@ -219,15 +219,15 @@ Delete a pipeline action.
219219
tw actions delete [OPTIONS]
220220
```
221221

222-
### Options
222+
#### Options
223223

224224
| Option | Description | Required | Default |
225225
|--------|-------------|----------|----------|
226226
| `-i`, `--id` | Action unique identifier | No | `null` |
227227
| `-n`, `--name` | Action name | No | `null` |
228228
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
229229

230-
### Example
230+
#### Example
231231

232232
Command:
233233

@@ -249,7 +249,7 @@ Manage pipeline action labels.
249249
tw actions labels [OPTIONS]
250250
```
251251

252-
### Options
252+
#### Options
253253

254254
| Option | Description | Required | Default |
255255
|--------|-------------|----------|----------|
@@ -259,7 +259,7 @@ tw actions labels [OPTIONS]
259259
| `--no-create` | Assign labels without creating the ones which were not found. | No | `null` |
260260
| `--operations`, `-o` | Type of operation (set, append, delete) [default: set]. | No | `set` |
261261

262-
### Example
262+
#### Example
263263

264264
Command:
265265

‎platform-cli-docs/docs/reference/collaborators.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ List organization collaborators.
1717
tw collaborators list [OPTIONS]
1818
```
1919

20-
### Options
20+
#### Options
2121

2222
| Option | Description | Required | Default |
2323
|--------|-------------|----------|----------|
@@ -27,7 +27,7 @@ tw collaborators list [OPTIONS]
2727
| `--offset` | Row offset for paginated results (default: 0) | No | `null` |
2828
| `--max` | Maximum number of records to display (default: ) | No | `null` |
2929

30-
### Example
30+
#### Example
3131

3232
Command:
3333

‎platform-cli-docs/docs/reference/compute-envs.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Run `tw compute-envs add <platform> -h` to view the required and optional fields
2525

2626
You must add the credentials for your provider before creating your compute environment.
2727

28-
### Example
28+
#### Example
2929

3030
Command:
3131

@@ -60,7 +60,7 @@ Update a compute environment.
6060
tw compute-envs update [OPTIONS]
6161
```
6262

63-
### Options
63+
#### Options
6464

6565
| Option | Description | Required | Default |
6666
|--------|-------------|----------|---------|
@@ -69,7 +69,7 @@ tw compute-envs update [OPTIONS]
6969
| `-n`, `--name` | Compute environment name. | No | `null` |
7070
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
7171

72-
### Example
72+
#### Example
7373

7474
Command:
7575

@@ -91,15 +91,15 @@ Delete a compute environment.
9191
tw compute-envs delete [OPTIONS]
9292
```
9393

94-
### Options
94+
#### Options
9595

9696
| Option | Description | Required | Default |
9797
|--------|-------------|----------|---------|
9898
| `-i`, `--id` | Compute environment unique identifier. | No | `null` |
9999
| `-n`, `--name` | Compute environment name. | No | `null` |
100100
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
101101

102-
### Example
102+
#### Example
103103

104104
Command:
105105

@@ -121,15 +121,15 @@ View compute environment details.
121121
tw compute-envs view [OPTIONS]
122122
```
123123

124-
### Options
124+
#### Options
125125

126126
| Option | Description | Required | Default |
127127
|--------|-------------|----------|---------|
128128
| `-i`, `--id` | Compute environment unique identifier. | No | `null` |
129129
| `-n`, `--name` | Compute environment name. | No | `null` |
130130
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
131131

132-
### Example
132+
#### Example
133133

134134
Command:
135135

@@ -190,13 +190,13 @@ List compute environments.
190190
tw compute-envs list [OPTIONS]
191191
```
192192

193-
### Options
193+
#### Options
194194

195195
| Option | Description | Required | Default |
196196
|--------|-------------|----------|---------|
197197
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
198198

199-
### Example
199+
#### Example
200200

201201
Command:
202202

@@ -229,15 +229,15 @@ Export compute environment configuration as a JSON file.
229229
tw compute-envs export [OPTIONS]
230230
```
231231

232-
### Options
232+
#### Options
233233

234234
| Option | Description | Required | Default |
235235
|--------|-------------|----------|---------|
236236
| `-i`, `--id` | Compute environment unique identifier. | No | `null` |
237237
| `-n`, `--name` | Compute environment name. | No | `null` |
238238
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
239239

240-
### Example
240+
#### Example
241241

242242
Command:
243243

@@ -259,7 +259,7 @@ Import a compute environment configuration from a JSON file.
259259
tw compute-envs import [OPTIONS] <path/to/json-file>
260260
```
261261

262-
### Options
262+
#### Options
263263

264264
| Option | Description | Required | Default |
265265
|--------|-------------|----------|---------|
@@ -269,7 +269,7 @@ tw compute-envs import [OPTIONS] <path/to/json-file>
269269
| `--overwrite` | Overwrite the compute environment if it already exists. | No | `false` |
270270
| `<path/to/json-file>` | Path to the JSON file containing the compute environment configuration (exported using `tw compute-envs export`). | Yes | `null` |
271271

272-
### Example
272+
#### Example
273273

274274
Command:
275275

@@ -303,13 +303,13 @@ Get the primary compute environment.
303303
tw compute-envs primary get [OPTIONS]
304304
```
305305

306-
### Options
306+
#### Options
307307

308308
| Option | Description | Required | Default |
309309
|--------|-------------|----------|---------|
310310
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
311311

312-
### Example
312+
#### Example
313313

314314
Command:
315315

@@ -331,15 +331,15 @@ Set a compute environment as primary.
331331
tw compute-envs primary set [OPTIONS]
332332
```
333333

334-
### Options
334+
#### Options
335335

336336
| Option | Description | Required | Default |
337337
|--------|-------------|----------|---------|
338338
| `-i`, `--id` | Compute environment unique identifier. | No | `null` |
339339
| `-n`, `--name` | Compute environment name. | No | `null` |
340340
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
341341

342-
### Example
342+
#### Example
343343

344344
Command:
345345

‎platform-cli-docs/docs/reference/credentials.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Run `tw credentials update -h` to view a list of providers.
9999

100100
Run `tw credentials update <provider> -h` to view the required fields for your provider.
101101

102-
### Common Options
102+
#### Common Options
103103

104104
| Option | Description | Required | Default |
105105
|--------|-------------|----------|---------|
@@ -111,7 +111,7 @@ Run `tw credentials update <provider> -h` to view the required fields for your p
111111
Additional provider-specific options vary depending on the provider type. Use `tw credentials update <provider> -h` to see all available options for your provider. Either credentials ID (`-i`) or name (`-n`) is required to identify which credentials to update.
112112
:::
113113

114-
### Example
114+
#### Example
115115

116116
Command:
117117

@@ -133,15 +133,15 @@ Delete workspace credentials.
133133
tw credentials delete [OPTIONS]
134134
```
135135

136-
### Options
136+
#### Options
137137

138138
| Option | Description | Required | Default |
139139
|--------|-------------|----------|---------|
140140
| `-i`, `--id` | Credentials unique identifier | No | `null` |
141141
| `-n`, `--name` | Credentials name | No | `null` |
142142
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
143143

144-
### Example
144+
#### Example
145145

146146
Command:
147147

@@ -163,13 +163,13 @@ List workspace credentials.
163163
tw credentials list [OPTIONS]
164164
```
165165

166-
### Options
166+
#### Options
167167

168168
| Option | Description | Required | Default |
169169
|--------|-------------|----------|---------|
170170
| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
171171

172-
### Example
172+
#### Example
173173

174174
Command:
175175

0 commit comments

Comments
 (0)