Skip to content

Explain required GITHUB_TOKEN permissions #40

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 16, 2022
Merged

Explain required GITHUB_TOKEN permissions #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,23 @@ The following are *required* as `step.env` keys
|----------------|--------------------------------------|
| `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets`|

## required permissions

Because this application leverages the `GITHUB_TOKEN` to make API requests, the
permissions granted to the token must be sufficient to make the API requests.
By default, the token has wide enough permissions to allow all API requests
made by this action. If you are customizing your token permissions, you must
explicitly specify all permissions, including those that you need that would
otherwise be granted by the defaults. See ["Permissions for the
GITHUB_TOKEN"](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)
In the GitHub Actions documentation.

If you need to specify explicit permissions for the API requests made by this
action, the permissions required are:

- `actions:read` - this permission is required for the [listWorkflowRunsForRepo](https://octokit.github.io/rest.js/v18#actions-list-workflow-runs-for-repo)
API request.

## cost of coordination

At this time there is no way to coordinate between workflow runs beyond waiting. For those using private repositories, [you are charged based on the time your workflow spends running](https://github.com/features/actions#pricing-details). Waiting within one workflow run for another to complete will incur the cost of the time spent waiting.
Expand Down