docs: warn about GITHUB_TOKEN limitation for status checks#124
Open
ricogu wants to merge 1 commit into
Open
Conversation
When consumers pass secrets.GITHUB_TOKEN, commits pushed by this action are made by github-actions[bot] and GitHub will not re-trigger other workflow runs (CI, tests, etc.) on the bump commit. Document this limitation in action.yml token input description and add a dedicated section in the README with guidance on using a PAT or GitHub App token instead.
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Documents a known GitHub platform limitation: when consumers pass
secrets.GITHUB_TOKENas thetokeninput, commits pushed by this action are made by thegithub-actions[bot]identity, and GitHub intentionally does not re-trigger other workflow runs on such pushes. This means CI checks, tests, linting, and other status checks will not run on the version-bump commit.Changes Made
action.yml: Expandedtokeninput description to include an inline warning about theGITHUB_TOKENlimitation and guidance to use a PAT or GitHub App token instead.README.md: Added a dedicatedGITHUB_TOKEN and Status Checkssection under Inputs with a clear warning, explanation, and code example for using a PAT.Type of Change
Checklist