1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-04-11 11:42:15 +02:00

docs: document required GitHub Actions token privileges (#2180)

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
Radek Simko 2021-04-21 20:45:14 +01:00 committed by GitHub
parent 0c2e80ae93
commit f802d5ead9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -21,6 +21,9 @@ on:
pull_request:
push:
permissions:
contents: write
jobs:
goreleaser:
runs-on: ubuntu-latest
@ -133,7 +136,16 @@ Following environment variables can be used as `step.env` keys
|----------------|-------------------------------------------------------|
| `GITHUB_TOKEN` | [GITHUB_TOKEN][github-token] as provided by `secrets` |
## Limitations
## Token Permissions
The following [permissions](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token) are required by GoReleaser:
- `content: write` if you wish to
- [upload archives as GitHub Releases](/customization/release/), or
- publish to [Homebrew](/customization/homebrew/), or [Scoop](/customization/scoop/) (assuming it's part of the same repository)
- or just `content: read` if you don't need any of the above
- `packages: write` if you [push Docker images](/customization/docker/) to GitHub
- `issues: write` if you use [milestone closing capability](/customization/milestone/)
`GITHUB_TOKEN` permissions [are limited to the repository][about-github-token] that contains your workflow.