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

Update token permissions documentation 🗝️ #418

Merged
merged 1 commit into from
Jun 7, 2024
Merged

Update token permissions documentation 🗝️ #418

merged 1 commit into from
Jun 7, 2024

Conversation

jamacku
Copy link
Member

@jamacku jamacku commented Jun 7, 2024

No description provided.

@jamacku jamacku added the type: documentation Improvements or additions to documentation label Jun 7, 2024
@jamacku jamacku linked an issue Jun 7, 2024 that may be closed by this pull request
Copy link

codecov bot commented Jun 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.71%. Comparing base (5bfdb52) to head (427e1f2).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #418   +/-   ##
=======================================
  Coverage   85.71%   85.71%           
=======================================
  Files           5        5           
  Lines         315      315           
=======================================
  Hits          270      270           
  Misses         45       45           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.md Outdated
* Token with the `security_events: write` scope to use this endpoint for private repositories.
* Token with the `public_repo` scope for **public repositories only**.
* `security_events: write` scope for **all repositories**.
* `actions: read` and `contents: read` scopes for **private repositories only**.
Copy link

@jasonkarns jasonkarns Jun 7, 2024

Choose a reason for hiding this comment

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

Probably worth phrasing in a way to be clear that the private repo requirements are "in addition to" as opposed to "instead of"

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you. I have tried to make it a bit more straightforward. I hope it helps.

Choose a reason for hiding this comment

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

nice! (it would be nice if github made more of this official in the action.yml format. having a structured format for what permissions are required, under what circumstances, and be consistent between actions would be nice)

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree with this 100%

@jasonkarns
Copy link

i appreciate the additional clarity!

@jamacku jamacku merged commit c439092 into main Jun 7, 2024
9 of 10 checks passed
@jamacku jamacku deleted the token-doc branch June 7, 2024 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Token permissions confusion
2 participants