docs: write permission to Actions example to avoid 403 on push#4833
Open
nanami-takemoto wants to merge 1 commit intoanuraghazra:masterfrom
Open
docs: write permission to Actions example to avoid 403 on push#4833nanami-takemoto wants to merge 1 commit intoanuraghazra:masterfrom
nanami-takemoto wants to merge 1 commit intoanuraghazra:masterfrom
Conversation
|
@nanami-takemoto is attempting to deploy a commit to the github readme stats Team on Vercel. A member of the Team first needs to authorize it. |
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
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
When setting up the GitHub Actions workflow from the README, the job may fail when trying to push the generated SVG files back to the repository.
Example error:
This happens when the repository uses read-only default workflow permissions, which is now the default setting for many repositories.
In that configuration, the
GITHUB_TOKENdoes not have permission to push commits.Changes
The GitHub Actions example in the README now explicitly includes:
This allows the workflow to push the generated files back to the repository.
Explicitly specifying this permission makes the example work out-of-the-box even for repositories using read-only default workflow permissions.
It also makes the required permission clearer for users who are new to GitHub Actions.
The same permission is also documented in the GitHub Actions version of this project:
https://github.com/stats-organization/github-readme-stats-action#readme