docs icon indicating copy to clipboard operation
docs copied to clipboard

doc: add note about `pull_request` permissions

Open redyetidev opened this issue 9 months ago • 3 comments

Why:

Personally, I think this clarification will help users (like me) decide on what workflow event is best for them (pull_request or pull_request_target)

What's being changed (if available, include any code snippets, screenshots, or gifs):

To the pull_request event notes:

+ - Workflows triggered by the `pull_request` event will not be granted access to secrets, and any permissions set will not surpass `read` access.

Check off the following:

  • [x] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • [x] For content changes, I have completed the self-review checklist.

redyetidev avatar May 14 '24 00:05 redyetidev

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar May 14 '24 00:05 welcome[bot]

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/using-workflows/events-that-trigger-workflows.md fpt
ghec
ghes@ 3.12 3.11 3.10 3.9
fpt
ghec
ghes@ 3.12 3.11 3.10 3.9

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server

github-actions[bot] avatar May 14 '24 00:05 github-actions[bot]

@RedYetiDev Thanks so much for opening a PR! I'll get this triaged for review ✨

nguyenalex836 avatar May 14 '24 15:05 nguyenalex836

Hi @RedYetiDev 👋 Thank you for your contribution ⭐ Documentation for permissions are located at Assigning permissions to jobs and can apply to more than just the pull_request event. We will close the issue with no further actions. Our goal is to ensure our documentation is simple and concise. Thank you for understanding and being a valued part of our community.

sunbrye avatar Jul 15 '24 17:07 sunbrye