Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add a note to use contents: read for checkout #63

Merged
merged 1 commit into from
Feb 19, 2025
Merged

Conversation

GrantBirki
Copy link
Member

This permission is not required in every usage of github/command but many folks use it in combination with workflows that checkout the repository. Adding it to the main readme makes sense.

related: #49

@GrantBirki GrantBirki added the documentation Improvements or additions to documentation label Feb 19, 2025
@Copilot Copilot bot review requested due to automatic review settings February 19, 2025 21:35
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@GrantBirki GrantBirki merged commit dee6417 into main Feb 19, 2025
4 checks passed
@GrantBirki GrantBirki deleted the contents-read-note branch February 19, 2025 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant