8000 clarify requirements for the `github-username` input · coder/start-workspace-action@0054568 · GitHub
[go: up one dir, main page]
Skip to content {"props":{"docsUrl":"https://docs.github.com/get-started/accessibility/keyboard-shortcuts"}}

Commit 0054568

Browse files
hugodutkahugodutka
committed
clarify requirements for the github-username input
1 parent f3cda2e commit 0054568

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

‎README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ jobs:
6464
| --------------------- | ------------------------------------------------------------------------------------------------------- | -------- | --------------------------------- |
6565
| `github-token` | GitHub token for posting comments | No | `${{ github.token }}` |
6666
| `github-issue-number` | GitHub issue number where the status comment will be posted | No | Current issue from GitHub context |
67-
| `github-username` | GitHub username of the user for whom the workspace is being started | No | - |
67+
| `github-username` | GitHub username of the user for whom the workspace is being started (requires Coder 2.21 or later) | No | - |
6868
| `coder-username` | Coder username to override default user mapping (only set one of `github-username` or `coder-username`) | No | - |
6969
| `coder-url` | Coder deployment URL | Yes | - |
7070
| `coder-token` | API token for Coder | Yes | - |
@@ -82,8 +82,9 @@ jobs:
8282

8383
## Requirements
8484

85-
- A Coder deployment with API access
86-
- Appropriate secrets configured in your repository or environment
85+
- A Coder deployment with API access.
86+
- Coder 2.21 or later to use the `github-username` input. Earlier versions of Coder can use the `coder-username` input instead.
87+
- Appropriate secrets configured in your repository or environment.
8788

8889
## Security Recommendations
8990

0 commit comments

Comments
 (0)
0