From f7855016d20e6c3fc503f3fae16948899d9890f4 Mon Sep 17 00:00:00 2001 From: Jeroen de Bruijn Date: Fri, 20 Mar 2020 22:16:44 +0100 Subject: [PATCH] docs: add note about usage of token and non-working GITHUB_TOKEN --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1ceb71a1..a11c24e9 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,9 @@ The [`branchPrefix`](https://docs.renovatebot.com/configuration-options/#branchp ## `token` -[Generate a personal access token](https://github.com/settings/tokens), with `public_repo` rights for only public repositories or `repo` rights for public and private repositories, and add it to _Secrets_ (repository settings) as `RENOVATE_TOKEN`. The name of the secret can be anything as long as it matches the argument given to the `token` option. +[Generate a personal access token](https://github.com/settings/tokens), with `public_repo` rights for only public repositories or `repo` rights for public and private repositories, and add it to _Secrets_ (repository settings) as `RENOVATE_TOKEN`. This token is only used by Renovate, see the [token configuration](https://docs.renovatebot.com/self-hosted-configuration/#token), and gives it access to the repositories. The name of the secret can be anything as long as it matches the argument given to the `token` option. + +Note that the [`GITHUB_TOKEN`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token) secret can't be used for authenticating Renovate.