renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-12 06:56:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

docs: fix single space list items

Browse source
This commit is contained in:
Rhys Arkins 2021-03-09 22:57:29 +01:00
parent 243c25ff4d
commit 1d5eee9075
3 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/usage/configuration-options.md
View file

@ -1605,11 +1605,11 @@ Therefore you can customise this setting if you wish to be notified a little lat
This setting - if enabled - helps slow down Renovate, particularly during the onboarding phase. What may happen without this setting is:
1. Onboarding PR is created
2. User merges onboarding PR to activate Renovate
3. Renovate creates a "Pin Dependencies" PR (if necessary)
4. User merges Pin PR
5. Renovate then creates every single upgrade PR necessary - potentially dozens
1. Onboarding PR is created
2. User merges onboarding PR to activate Renovate
3. Renovate creates a "Pin Dependencies" PR (if necessary)
4. User merges Pin PR
5. Renovate then creates every single upgrade PR necessary - potentially dozens
The above can result in swamping CI systems, as well as a lot of retesting if branches need to be rebased every time one is merged.
Instead, if `prHourlyLimit` is configure to a value like 1 or 2, it will mean that Renovate creates at most that many new PRs within each hourly period (:00-:59).
@ -1676,11 +1676,11 @@ Behavior:
Renovate's `"auto"` strategy works like this for npm:
1. Always pin `devDependencies`
2. Pin `dependencies` if we detect that it's an app and not a library
3. Widen `peerDependencies`
4. If an existing range already ends with an "or" operator - e.g. `"^1.0.0 || ^2.0.0"` - then Renovate will widen it, e.g. making it into `"^1.0.0 || ^2.0.0 || ^3.0.0"`
5. Otherwise, replace the range. e.g. `"^2.0.0"` would be replaced by `"^3.0.0"`
1. Always pin `devDependencies`
2. Pin `dependencies` if we detect that it's an app and not a library
3. Widen `peerDependencies`
4. If an existing range already ends with an "or" operator - e.g. `"^1.0.0 || ^2.0.0"` - then Renovate will widen it, e.g. making it into `"^1.0.0 || ^2.0.0 || ^3.0.0"`
5. Otherwise, replace the range. e.g. `"^2.0.0"` would be replaced by `"^3.0.0"`
**bump**

8
docs/usage/private-modules.md
View file

@ -129,13 +129,13 @@ If instead you use an alternative registry or need an `.npmrc` file for some oth
Renovate will then use the following logic:
1. If no `npmrc` string is present in config then one will be created with the `_authToken` pointing to the default npmjs registry
2. If an `npmrc` string is present and contains `${NPM_TOKEN}` then that placeholder will be replaced with the decrypted token
3. If an `npmrc` string is present but doesn't contain `${NPM_TOKEN}` then the file will have `_authToken=<token>` appended to it
1. If no `npmrc` string is present in config then one will be created with the `_authToken` pointing to the default npmjs registry
2. If an `npmrc` string is present and contains `${NPM_TOKEN}` then that placeholder will be replaced with the decrypted token
3. If an `npmrc` string is present but doesn't contain `${NPM_TOKEN}` then the file will have `_authToken=<token>` appended to it
### Encrypted entire .npmrc file into config
Copy the entire .npmrc, replace newlines with `\n` chars, and then try encrypting it at https://renovatebot.com/encrypt
Copy the entire .npmrc, replace newlines with `\n` chars, and then try encrypting it at <https://renovatebot.com/encrypt>
You will then get an encrypted string that you can substitute into your renovate.json instead.
The result will now look something like this:

4
docs/usage/updating-rebasing.md
View file

@ -27,8 +27,8 @@ You can disable this functionality by configuring `"rebaseWhen": "never"` (not r
There are two cases where Renovate will rebase its branches off the base branch every time they are out of date:
1. If you configure `"rebaseWhen": "behind-base-branch"`
2. If you use the default configuration `"rebaseWhen": "auto"` and the repository has a requirement that branches must be up-to-date before merging (e.g. "Require branches to be up to date before merging" on GitHub, or FF-only settings on Bitbucket Server or GitLab)
1. If you configure `"rebaseWhen": "behind-base-branch"`
2. If you use the default configuration `"rebaseWhen": "auto"` and the repository has a requirement that branches must be up-to-date before merging (e.g. "Require branches to be up to date before merging" on GitHub, or FF-only settings on Bitbucket Server or GitLab)
In that case Renovate PRs will be rebased off the repository's base branch whenever they are behind the base branch, even if the PRs are not conflicted.