8000 update input descriptions · coder/start-workspace-action@747b408 · GitHub
[go: up one dir, main page]

Skip to content

Commit 747b408

Browse files
committed
update input descriptions
1 parent e526e6f commit 747b408

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

action.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
name: 'Start Coder Workspace'
2-
description: 'Starts a Coder workspace. Posts a comment to a GitHub issue with the workspace URL.'
2+
description: 'Starts a Coder workspace and posts status updates as comments on a GitHub issue.'
33
inputs:
44
github-token:
5-
description: 'GitHub token'
5+
description: 'GitHub token for posting comments'
66
required: false
77
default: ${{ github.token }}
88
github-issue-number:
9-
description: 'GitHub issue number where progress updates will be posted'
9+
description: 'GitHub issue number where comments will be posted'
1010
required: true
1111
github-username:
1212
description: 'GitHub username of the user for whom the workspace is being started'
1313
required: false
1414
coder-username:
15-
description: 'Coder username'
15+
description: 'Coder username to override default user mapping (only set one of github-username or coder-username)'
1616
required: false
1717
coder-url:
18-
description: 'Coder URL'
18+
description: 'Coder deployment URL'
1919
required: true
2020
coder-token:
21-
description: 'Coder token'
21+
description: 'API token for Coder'
2222
required: true
2323
template-name:
24-
description: 'Coder template name'
24+
description: 'Name of the Coder template to use'
2525
required: true
2626
workspace-name:
27-
description: 'Coder workspace name'
27+
description: 'Name for the new workspace'
2828
required: true
2929
parameters:
30-
description: 'YAML dictionary of parameters for the Coder workspace'
30+
description: 'YAML-formatted parameters for the Coder workspace'
3131
required: true
3232

3333
runs:

0 commit comments

Comments
 (0)
0