Update ci-configuration.md

Document support for GitHub App installation access tokens for users running semantic-release as a GitHub app but outside of GitHub actions. #1807
semantic-release · Feb 16, 2022 · b392081 · b392081
1 parent 2c30e26
commit b392081
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/usage/ci-configuration.md b/docs/usage/ci-configuration.md
@@ -23,7 +23,7 @@ See [CI configuration recipes](../recipes/ci-configurations/README.md) for more
 
 | Variable                                              | Description                                                                                                                                                                                                                  |
 |-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `GH_TOKEN` or `GITHUB_TOKEN`                          | A GitHub [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).                                                                                                    |
+| `GH_TOKEN` or `GITHUB_TOKEN`                          | A GitHub [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) or [installation access token](https://docs.github.com/en/rest/reference/apps#create-an-installation-access-token-for-an-app)[^authenticate-as-a-github-app-installation].                                                                                                    |
 | `GL_TOKEN` or `GITLAB_TOKEN`                          | A GitLab [personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html).                                                                                                                       |
 | `BB_TOKEN` or `BITBUCKET_TOKEN`                       | A Bitbucket [personal access token](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html).                                                                                                 |
 | `BB_TOKEN_BASIC_AUTH` or `BITBUCKET_TOKEN_BASIC_AUTH` | A Bitbucket [personal access token](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html) with basic auth support. For clearification `user:token` has to be the value of this env.        |
@@ -47,3 +47,5 @@ The authentication token/credentials have to be made available in the CI service
 See [CI configuration recipes](../recipes/ci-configurations/README.md) for more details on how to configure environment variables in your CI service.
 
 **Note**: The environment variables `GH_TOKEN`, `GITHUB_TOKEN`, `GL_TOKEN` and `GITLAB_TOKEN` can be used for both the Git authentication and the API authentication required by [@semantic-release/github](https://github.com/semantic-release/github) and [@semantic-release/gitlab](https://github.com/semantic-release/gitlab).
+
+[^authenticate-as-a-github-app-installation]: You must also set the `GITHUB_ACTION` environment variable to `yes` for `semantic-release` to treat the token as a GitHub App installation access token as opposed to a personal access token.