Update the sample in README.md with explicit permission control. #31
Conversation
This file contains 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
By adding the explict permission declaration, user can deploy the
HTML document with default workflow permission of their repository.
permissions:
contents: write
pages: write
DenverCoder1
approved these changes
Sep 26, 2024
|
Looks great! Thanks for the contribution 🎉 |
|
My pleasure. Thank you for merging the PR. Have a good day! |
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.
By adding the explicit permission declaration, the user can deploy the HTML document with the default workflow permission of their repository.
In issue #24, It is suggested to change the Workflow permission of the user repository setting from "Read repository contents and packages permissions" (default) to "Read and write permissions", to avoid the error at deployment by GitHub actions (See the figure below).
This explicit permission declaration in this pull request has two advantages compared to the one suggested in Issue #24.
The changed YAMLs inside README.md have been tested with my test repository. I confirmed they work fine.