From 0054568c043bba479899edb91ef96a5cfca21c55 Mon Sep 17 00:00:00 2001 From: Hugo Dutka Date: Tue, 1 Apr 2025 13:44:45 +0200 Subject: [PATCH 1/2] clarify requirements for the `github-username` input --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4c01653..e72e514 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ jobs: | --------------------- | ------------------------------------------------------------------------------------------------------- | -------- | --------------------------------- | | `github-token` | GitHub token for posting comments | No | `${{ github.token }}` | | `github-issue-number` | GitHub issue number where the status comment will be posted | No | Current issue from GitHub context | -| `github-username` | GitHub username of the user for whom the workspace is being started | No | - | +| `github-username` | GitHub username of the user for whom the workspace is being started (requires Coder 2.21 or later) | No | - | | `coder-username` | Coder username to override default user mapping (only set one of `github-username` or `coder-username`) | No | - | | `coder-url` | Coder deployment URL | Yes | - | | `coder-token` | API token for Coder | Yes | - | @@ -82,8 +82,9 @@ jobs: ## Requirements -- A Coder deployment with API access -- Appropriate secrets configured in your repository or environment +- A Coder deployment with API access. +- Coder 2.21 or later to use the `github-username` input. Earlier versions of Coder can use the `coder-username` input instead. +- Appropriate secrets configured in your repository or environment. ## Security Recommendations From 35a4608cefc7e8cc56573cae7c3b85304575cb72 Mon Sep 17 00:00:00 2001 From: Hugo Dutka Date: Tue, 1 Apr 2025 13:47:13 +0200 Subject: [PATCH 2/2] update `github-username` description to specify requirement for Coder 2.21 or newer --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e72e514..c9c377f 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ jobs: | --------------------- | ------------------------------------------------------------------------------------------------------- | -------- | --------------------------------- | | `github-token` | GitHub token for posting comments | No | `${{ github.token }}` | | `github-issue-number` | GitHub issue number where the status comment will be posted | No | Current issue from GitHub context | -| `github-username` | GitHub username of the user for whom the workspace is being started (requires Coder 2.21 or later) | No | - | +| `github-username` | GitHub username of the user for whom the workspace is being started (requires Coder 2.21 or newer) | No | - | | `coder-username` | Coder username to override default user mapping (only set one of `github-username` or `coder-username`) | No | - | | `coder-url` | Coder deployment URL | Yes | - | | `coder-token` | API token for Coder | Yes | - |