Uh oh!
There was an error while loading. Please reload this page.
docs(github): correct GitHub Action inputs - #44668
Closed
harshil-mistry wants to merge 1 commit into
Closed
Conversation
The Configuration list documented a `token` input that action.yml does not define, and omitted use_github_token, mentions, variant and oidc_base_url. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This was referenced Aug 24, 2026
neriousy
commented
Aug 24, 2026
Contributor
Thanks @harshil-mistry for identifying the stale GitHub Action input documentation. This is superseded by #44793 ( |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue for this PR
Closes#44667
Type of change
What does this PR do?
The Configuration list on the GitHub Action docs page didn't match
github/action.yml.It documented a
tokeninput, which the action doesn't define — so anyone following the docs and settingwith: token: ...gets it silently ignored, because composite actions just drop unknown inputs. The setup example had the same problem with a commented-out# github_token: xxxx. At the same time, four inputs that do exist (use_github_token,mentions,variant,oidc_base_url) weren't documented at all.So this replaces the
tokenbullet withuse_github_tokenand adds the three missing ones, and changes the example's commented line to# use_github_token: true.I also reworded the paragraph under it. It previously read as "alternatively you can use the built-in GITHUB_TOKEN", which suggested that using the runner token was a separate path from the input. It isn't —
use_github_token: trueis what selects it, and the token still has to be passed inenv.github.handler.tsreadsUSE_GITHUB_TOKENand then requiresGITHUB_TOKEN, throwingGITHUB_TOKEN environment variable is not set. When using use_github_token, you must provide GITHUB_TOKEN.if it's absent. The PR example further down the same page already passes it that way, so this makes the Configuration section agree with the example.Descriptions for the new bullets are taken from the
descriptionfields inaction.ymland the defaults in the handler (mentionsdefaults to/opencode,/oc,oidc_base_urldefaults tohttps://api.opencode.ai,use_github_tokendefaults tofalse).How did you verify your code works?
Docs-only change, so there's nothing to run. I checked it by diffing the documented inputs against the
inputs:block ingithub/action.yml, and by tracing each one to where it's consumed:USE_GITHUB_TOKENandOIDC_BASE_URLingithub.handler.ts,MENTIONSin the same file with the/opencode,/ocfallback, andVARIANT/AGENT/SHARE/PROMPTpassed through the action'senvblock.A reviewer can confirm by comparing the bullet list against
github/action.yml.Screenshots / recordings
Not a UI change.
Checklist