Skip to content
Snippets Groups Projects
Unverified Commit 9afabcd8 authored by HonkingGoose's avatar HonkingGoose Committed by GitHub
Browse files

docs(running renovate): use admonitions (#13884)

parent c4af347d
No related branches found
No related tags found
No related merge requests found
......@@ -128,7 +128,9 @@ If you are configuring using environment variables, there are two possibilities:
If you combine both of the above then any single config option in the environment variable will override what's in `RENOVATE_CONFIG`.
Note: it's also possible to change the default prefix from `RENOVATE_` using `ENV_PREFIX`. e.g. `ENV_PREFIX=RNV_ RNV_TOKEN=abc123 renovate`.
<!-- prettier-ignore -->
!!! note
It's also possible to change the default prefix from `RENOVATE_` using `ENV_PREFIX`. e.g. `ENV_PREFIX=RNV_ RNV_TOKEN=abc123 renovate`.
#### Using `config.js`
......@@ -190,7 +192,10 @@ A way to get the user id of a GitHub app is to [query the user API](https://docs
**`token:"x-access-token:${github-app-installation}"`**
The token needs to be prefixed with `x-access-token` and be a [GitHub App Installation token](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-an-installation).
**Note** The installation tokens expire after 1 hour and need to be regenerated regularly.
<!-- prettier-ignore -->
!!! note
The installation tokens expire after 1 hour and need to be regenerated regularly.
Alternatively as environment variable `RENOVATE_TOKEN`, or via CLI `--token=`.
**`repositories: ["orgname/repo-1","orgname/repo-2"]`**
......@@ -247,7 +252,10 @@ This account can actually be _any_ account on GitHub, and needs only read-only a
It's used when fetching release notes for repositories in order to increase the hourly API limit.
It's also OK to configure the same as a host rule instead, if you prefer that.
**Note:** If you're using Renovate in a project where dependencies are loaded from github.com (such as Go modules hosted on GitHub) it is highly recommended to add a token as you will exceed the rate limit from the github.com API, which will lead to Renovate closing and reopening PRs because it could not get reliable info on updated dependencies.
<!-- prettier-ignore -->
!!! note
If you're using Renovate in a project where dependencies are loaded from github.com (such as Go modules hosted on GitHub) it is highly recommended to add a token.
Otherwise you will exceed the rate limit from the github.com API, which will lead to Renovate closing and reopening PRs because it could not get reliable info on updated dependencies.
### Self-hosting examples
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment