Docs: add warning about masking tokens in GitHub Actions (Fix #213) #335
Conversation
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
|
👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with |
|
Hi! Could you please review this PR when you get a chance? |
|
Hi! Could you please review this PR when you get a chance? |
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.
Resolves #213
Before the change?
-The README did not warn users that tokens generated by this action (e.g., from
POST /repos/{owner}/{repo}/actions/runners/registration-token) could appear in GitHub Actions logs. Users could accidentally expose sensitive tokens.After the change?
-Added a warning note in the README immediately after the minimal example usage, showing how to manually mask tokens to prevent them from appearing in workflow logs.
Pull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!