diff --git a/README.md b/README.md index 5284acef..05bfaea6 100644 --- a/README.md +++ b/README.md @@ -256,11 +256,17 @@ jobs: # Put your commands for running backend tests here ``` -## Permissions +## Recommended Permissions In order to add labels to pull requests, the GitHub labeler action requires write permissions on the pull-request. However, when the action runs on a pull request from a forked repository, GitHub only grants read access tokens for `pull_request` events, at most. If you encounter an `Error: HttpError: Resource not accessible by integration`, it's likely due to these permission constraints. To resolve this issue, you can modify the `on:` section of your workflow to use [`pull_request_target`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target) instead of `pull_request` (see example [above](#create-workflow)). This change allows the action to have write access, because `pull_request_target` alters the [context of the action](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target) and safely grants additional permissions. Refer to the [GitHub token permissions documentation](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) for more details about access levels and event contexts. +```yml + permissions: + contents: read + pull-requests: write +``` + ## Notes regarding `pull_request_target` event Using the `pull_request_target` event trigger involves several peculiarities related to initial set up of the labeler or updating version of the labeler.