diff --git a/README.md b/README.md index 3f87d33fe..825c10c9d 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,12 @@ When using the _GITHUB_TOKEN_, the **minimum required permissions** are: | `GITHUB_API_URL` or `GH_URL` or `GITHUB_URL` | The GitHub Enterprise endpoint. | | `GH_PREFIX` or `GITHUB_PREFIX` | The GitHub Enterprise API prefix. | +#### Using GitHub App Installation tokens + +If the token you are using is from a GitHub App Installation instead of a Personal Access Token, +then you must uuse `GITHUB_TOKEN` instead of `GH_TOKEN` and set `GITHUB_ACTION=true` in your environment prior to running. +[See `get-git-auth-url` for details](https://github.com/semantic-release/semantic-release/blob/fa241a2a06b593d1a04cb0af07ee31acd5b3cae8/lib/get-git-auth-url.js#L65-L67]). + ### Options | Option | Description | Default | @@ -218,4 +224,4 @@ Valid values for this option are `false`, `"top"` or `"bottom"`. ##### addReleases example -See [The introducing PR](https://github.com/semantic-release/github/pull/282) for an example on how it will look. \ No newline at end of file +See [The introducing PR](https://github.com/semantic-release/github/pull/282) for an example on how it will look.