add a note to use contents: read for checkout#63
Merged
GrantBirki merged 1 commit intomainfrom Feb 19, 2025
Merged
Conversation
There was a problem hiding this comment.
PR Overview
This PR adds a note in the README to recommend using the "contents: read" permission when workflows invoke actions/checkout.
- Adds "contents: read" permission with an inline comment
- Provides guidance for workflows requiring checkout
Reviewed Changes
| File | Description |
|---|---|
| README.md | Added "contents: read" permission with an inline note comment |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Tip: If you use Visual Studio Code, you can request a review from Copilot before you push from the "Source Control" tab. Learn more
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.
This permission is not required in every usage of
github/commandbut many folks use it in combination with workflows that checkout the repository. Adding it to the main readme makes sense.related: #49