docs: use one sentence per line (#7625)
This commit is contained in:
HonkingGoose
GitHub
Родитель
cdaf3e9097
Коммит
32dd490672
|
|
@ -2,7 +2,8 @@
|
|||
|
||||
## Security
|
||||
|
||||
If you think you've found a **security issue**, please do not mention it in this repository. Instead, email security@renovatebot.com with as much details as possible so that it can be handled confidentially.
|
||||
If you think you've found a **security issue**, please do not mention it in this repository.
|
||||
Instead, email security@renovatebot.com with as much details as possible so that it can be handled confidentially.
|
||||
|
||||
## Support
|
||||
|
||||
|
|
@ -14,12 +15,12 @@ If you've found a **bug** or have a **feature request** then please create an is
|
|||
|
||||
## Code
|
||||
|
||||
If you would like to fix a bug or implement a feature, please fork the repository and create a Pull Request. More information on getting set up locally can be found in [docs/development/local-development.md](https://github.com/renovatebot/renovate/blob/master/docs/development/local-development.md).
|
||||
If you would like to fix a bug or implement a feature, please fork the repository and create a Pull Request.
|
||||
More information on getting set up locally can be found in [docs/development/local-development.md](https://github.com/renovatebot/renovate/blob/master/docs/development/local-development.md).
|
||||
|
||||
Before you start any Pull Request, it's recommended that you create an issue to discuss
|
||||
first if you have any doubts about requirement or implementation. That way you can be sure that the maintainer(s)
|
||||
agree on what to change and how, and you can hopefully get a quick merge
|
||||
afterwards. Also, let the maintainers know that you plan to work on a particular issue so that no one else starts any duplicate work.
|
||||
Before you start any Pull Request, it's recommended that you create an issue to discuss first if you have any doubts about requirement or implementation.
|
||||
That way you can be sure that the maintainer(s) agree on what to change and how, and you can hopefully get a quick merge afterwards.
|
||||
Also, let the maintainers know that you plan to work on a particular issue so that no one else starts any duplicate work.
|
||||
|
||||
Pull Requests can only be merged once all status checks are green, which means `yarn test` passes, and coverage is 100%.
|
||||
|
||||
|
|
@ -31,12 +32,15 @@ Commit as many times as you need in your pull request branch.
|
|||
|
||||
## Slack collaboration with maintainers
|
||||
|
||||
Sometimes the codebase can be a challenge to navigate, especially for a first-time contributor. We don't want you spending an hour trying to work out something that would take us only a minute to explain.
|
||||
Sometimes the codebase can be a challenge to navigate, especially for a first-time contributor.
|
||||
We don't want you spending an hour trying to work out something that would take us only a minute to explain.
|
||||
|
||||
For that reason, we have a Slack channel dedicated to helping anyone who's working on Pull Requests for Renovate. Please email rhys@renovatebot.com and simply mention that you need an invitation to the channel.
|
||||
For that reason, we have a Slack channel dedicated to helping anyone who's working on Pull Requests for Renovate.
|
||||
Please email rhys@renovatebot.com and simply mention that you need an invitation to the channel.
|
||||
|
||||
## Legal
|
||||
|
||||
Pull Request authors must sign the [Renovate CLA](https://cla-assistant.io/renovateapp/renovate).
|
||||
|
||||
If you cannot or do not want to sign this CLA (e.g. your employment contract for your employer may not allow this), you should not submit a PR. Open an issue and someone else can do the work.
|
||||
If you cannot or do not want to sign this CLA (e.g. your employment contract for your employer may not allow this), you should not submit a PR.
|
||||
Open an issue and someone else can do the work.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
# Security Policy
|
||||
|
||||
Please send an email to [renovate-disclosure@whitesourcesoftware.com](mailto:renovate-disclosure@whitesourcesoftware.com) describing what you have found. Please do not raise an issue in this repository or publicize your concern in any other forum without giving us adequate time to investigate first.
|
||||
Please send an email to [renovate-disclosure@whitesourcesoftware.com](mailto:renovate-disclosure@whitesourcesoftware.com) describing what you have found.
|
||||
Please do not raise an issue in this repository or publicize your concern in any other forum without giving us adequate time to investigate first.
|
||||
|
|
|
|||
|
|
@ -22,7 +22,8 @@ The manager's `index.ts` file supports the following values/functions:
|
|||
|
||||
##### `extractPackageFile(content, packageFile, config)` (async, semi-mandatory)
|
||||
|
||||
This function is mandatory unless you use `extractAllPackageFiles` instead. It takes as arguments the file's content and optionally the file's full file pathname and config, and returns an array of detected/extracted dependencies, including:
|
||||
This function is mandatory unless you use `extractAllPackageFiles` instead.
|
||||
It takes as arguments the file's content and optionally the file's full file pathname and config, and returns an array of detected/extracted dependencies, including:
|
||||
|
||||
- dependency name
|
||||
- dependency type (e.g. dependencies, devDependencies, etc)
|
||||
|
|
@ -31,7 +32,8 @@ This function is mandatory unless you use `extractAllPackageFiles` instead. It t
|
|||
|
||||
This function doesn't necessarily need to _understand_ the file or even syntax that it is passed, instead it just needs to understand enough to extract an accurate list of dependencies.
|
||||
|
||||
As a general approach, we want to extract _all_ dependencies from each dependency file, even if they contain values we don't support. For any that have unsupported values that we cannot renovate, this `extractPackageFile` function should set a `skipReason` to a value that would be helpful to someone reading the logs.
|
||||
As a general approach, we want to extract _all_ dependencies from each dependency file, even if they contain values we don't support.
|
||||
For any that have unsupported values that we cannot renovate, this `extractPackageFile` function should set a `skipReason` to a value that would be helpful to someone reading the logs.
|
||||
|
||||
Also, if a file is passed to `extractPackageFile` which is a "false match" (e.g. not an actual package file, or contains no dependencies) then this function can return `null` to have it ignored and removed from the list of package files.
|
||||
|
||||
|
|
@ -47,7 +49,8 @@ This function takes an array of filenames as input and returns an array of filen
|
|||
|
||||
#### `getRangeStrategy(config)` (optional)
|
||||
|
||||
This optional function should be written if you wish the manager to support "auto" range strategies, e.g. pinning or not pinning depending on other values in the package file. `npm` uses this to pin `devDependencies` but not `dependencies` unless the package file is detected as an app.
|
||||
This optional function should be written if you wish the manager to support "auto" range strategies, e.g. pinning or not pinning depending on other values in the package file.
|
||||
`npm` uses this to pin `devDependencies` but not `dependencies` unless the package file is detected as an app.
|
||||
|
||||
If left undefined, then a default `getRangeStrategy` will be used that always returns "replace".
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,8 @@
|
|||
|
||||
## Multiple files per branch
|
||||
|
||||
Renovate can/should update multiple files in the same branch/PR. e.g. it might be `package.json` and `yarn.lock`, or it might be multiple `package.json` files in a monorepo.
|
||||
Renovate can/should update multiple files in the same branch/PR.
|
||||
e.g. it might be `package.json` and `yarn.lock`, or it might be multiple `package.json` files in a monorepo.
|
||||
|
||||
## One commit per branch
|
||||
|
||||
|
|
@ -12,4 +13,5 @@ A positive side effect of this is that it allows us to have a shortcut rule of,
|
|||
|
||||
## Updating branches
|
||||
|
||||
If files in an already-existing branch need updating (e.g. an even newer version has been released), then we still aim to have just one commit. We achieve this by force pushing with `git` to the existing branch.
|
||||
If files in an already-existing branch need updating (e.g. an even newer version has been released), then we still aim to have just one commit.
|
||||
We achieve this by force pushing with `git` to the existing branch.
|
||||
|
|
|
|||
|
|
@ -27,14 +27,11 @@ Default configuration values can be found in
|
|||
|
||||
### Configuration File
|
||||
|
||||
You can override default configuration using a configuration file, with default
|
||||
name `config.js` in the working directory. If you need an alternate location or
|
||||
name, set it in the environment variable `RENOVATE_CONFIG_FILE`.
|
||||
You can override default configuration using a configuration file, with default name `config.js` in the working directory.
|
||||
If you need an alternate location or name, set it in the environment variable `RENOVATE_CONFIG_FILE`.
|
||||
|
||||
Using a configuration file gives you very granular configuration options. For
|
||||
instance, you can override most settings at the global (file), repository, or
|
||||
package level. e.g. apply one set of labels for `backend/package.json` and a
|
||||
different set for `frontend/package.json` in the same repository.
|
||||
Using a configuration file gives you very granular configuration options.
|
||||
For instance, you can override most settings at the global (file), repository, or package level. e.g. apply one set of labels for `backend/package.json` and a different set for `frontend/package.json` in the same repository.
|
||||
|
||||
```javascript
|
||||
module.exports = {
|
||||
|
|
@ -52,7 +49,8 @@ module.exports = {
|
|||
$ node renovate --help
|
||||
```
|
||||
|
||||
To configure any `<list>` items, separate with commas. E.g. `renovate --labels=renovate,dependency`.
|
||||
To configure any `<list>` items, separate with commas.
|
||||
E.g. `renovate --labels=renovate,dependency`.
|
||||
|
||||
### renovate.json
|
||||
|
||||
|
|
@ -60,8 +58,7 @@ If you add a `renovate.json` file to the root of your repository, you can use th
|
|||
|
||||
### package.json
|
||||
|
||||
If you add configuration options to your `package.json` then these will override
|
||||
any other settings above.
|
||||
If you add configuration options to your `package.json` then these will override any other settings above.
|
||||
|
||||
```json
|
||||
"renovate": {
|
||||
|
|
|
|||
|
|
@ -4,11 +4,8 @@ This file documents the design choices as well as configuration options.
|
|||
|
||||
## Stateless
|
||||
|
||||
No state storage is needed on `renovate` or the source code repository apart
|
||||
from what you see publicly (branches, Pull Requests). It, therefore, doesn't
|
||||
matter if you stop/restart the script and would even still work if you had it
|
||||
running from two different locations, as long as their configuration was the
|
||||
same.
|
||||
No state storage is needed on `renovate` or the source code repository apart from what you see publicly (branches, Pull Requests).
|
||||
It, therefore, doesn't matter if you stop/restart the script and would even still work if you had it running from two different locations, as long as their configuration was the same.
|
||||
|
||||
## Synchronous Operation
|
||||
|
||||
|
|
@ -19,33 +16,27 @@ The script current processes repositories and branches within them all synchrono
|
|||
|
||||
## Cascading Configuration
|
||||
|
||||
Configuration options applied per-package (e.g. with package rules) override those applied per
|
||||
package-type, which override those per-repository, which override those which
|
||||
are global (all repositories).
|
||||
Configuration options applied per-package (e.g. with package rules) override those applied per package-type, which override those per-repository, which override those which are global (all repositories).
|
||||
|
||||
## Automatic discovery of package file locations
|
||||
|
||||
The default behaviour is to auto-discover all package file (e.g. `package.json`) locations in a repository and process them all. Doing so means that "monorepos" are supported by default. This can be overridden by the configuration option `includePaths`, where you list the file paths manually (e.g. limit to just `package.json` in the root of the repository).
|
||||
The default behaviour is to auto-discover all package file (e.g. `package.json`) locations in a repository and process them all.
|
||||
Doing so means that "monorepos" are supported by default.
|
||||
This can be overridden by the configuration option `includePaths`, where you list the file paths manually (e.g. limit to just `package.json` in the root of the repository).
|
||||
|
||||
## Separate Branches per dependency
|
||||
|
||||
By default, `renovate` will maintain separate branches per-dependency. So if 20
|
||||
dependencies need updating, there will be at least 20 branches/PRs. Although
|
||||
this may seem undesirable, it was considered even less desirable if all 20 were
|
||||
in the same Pull Request and it's up to the users to determine which dependency
|
||||
upgrade(s) caused the build to fail.
|
||||
By default, `renovate` will maintain separate branches per-dependency.
|
||||
So if 20 dependencies need updating, there will be at least 20 branches/PRs.
|
||||
Although this may seem undesirable, it was considered even less desirable if all 20 were in the same Pull Request and it's up to the users to determine which dependency upgrade(s) caused the build to fail.
|
||||
|
||||
However, it's still possible to override the default branch and PR name
|
||||
templates in such a way to produce a single branch for all dependencies. The
|
||||
`groupName` configuration option can be used at a repository level (e.g. give it
|
||||
the value `All`) and then all dependency updates will be in the same branch/PR.
|
||||
However, it's still possible to override the default branch and PR name templates in such a way to produce a single branch for all dependencies.
|
||||
The `groupName` configuration option can be used at a repository level (e.g. give it the value `All`) and then all dependency updates will be in the same branch/PR.
|
||||
|
||||
## Separate Minor and Major PRs
|
||||
|
||||
`renovate` will create multiple branches/PRs if both major and minor branch upgrades
|
||||
are available. For example, if the current example is 1.6.0 and upgrades to 1.7.0
|
||||
and 2.0.0 exist, then `renovate` will raise PRs for both the 1.x upgrade(s) and
|
||||
2.x upgrade(s).
|
||||
`renovate` will create multiple branches/PRs if both major and minor branch upgrades are available.
|
||||
For example, if the current example is 1.6.0 and upgrades to 1.7.0 and 2.0.0 exist, then `renovate` will raise PRs for both the 1.x upgrade(s) and 2.x upgrade(s).
|
||||
|
||||
- It's often the case that projects can't upgrade major dependency versions immediately.
|
||||
- It's also often the case that previous major versions continue receiving Minor or Patch updates.
|
||||
|
|
@ -64,29 +55,24 @@ Note: Branch names are configurable using string templates.
|
|||
|
||||
## Pull Request Recreation
|
||||
|
||||
By default, the script does not create a new PR if it finds an identical one
|
||||
already closed. This allows users to close unwelcome upgrade PRs and not worry about
|
||||
them being recreated every run. Typically this is most useful for major
|
||||
upgrades. This option is configurable.
|
||||
By default, the script does not create a new PR if it finds an identical one already closed.
|
||||
This allows users to close unwelcome upgrade PRs and not worry about them being recreated every run.
|
||||
Typically this is most useful for major upgrades.
|
||||
This option is configurable.
|
||||
|
||||
## Rebasing Unmergeable Pull Requests
|
||||
|
||||
With the default behaviour of one branch per dependency, it's often that case
|
||||
that a PR gets merge conflicts after an adjacent dependency update is merged.
|
||||
Although platforms often have a web interface for simple merge conflicts, this is
|
||||
still annoying to resolve manually.
|
||||
With the default behaviour of one branch per dependency, it's often that case that a PR gets merge conflicts after an adjacent dependency update is merged.
|
||||
Although platforms often have a web interface for simple merge conflicts, this is still annoying to resolve manually.
|
||||
|
||||
`renovate` will rebase any unmergeable branches and add the latest necessary
|
||||
commit on top of the most recent `master` commit.
|
||||
`renovate` will rebase any unmergeable branches and add the latest necessary commit on top of the most recent `master` commit.
|
||||
|
||||
Note: `renovate` will only do this if the original branch hasn't been modified
|
||||
by anyone else.
|
||||
Note: `renovate` will only do this if the original branch hasn't been modified by anyone else.
|
||||
|
||||
## Suppressing string templates from CLI
|
||||
|
||||
String templates (e.g. commit or PR name) are not configurable via CLI options,
|
||||
in order to not pollute the CLI help and make it unreadable. If you must
|
||||
configure via CLI, use an environment variable instead. e.g.
|
||||
String templates (e.g. commit or PR name) are not configurable via CLI options, in order to not pollute the CLI help and make it unreadable.
|
||||
If you must configure via CLI, use an environment variable instead. e.g.
|
||||
|
||||
```sh
|
||||
$ RENOVATE_BRANCH_NAME=foo renovate
|
||||
|
|
|
|||
|
|
@ -37,7 +37,8 @@ You can also use [SDKMAN](https://sdkman.io/) to manage Java versions.
|
|||
|
||||
_Windows_
|
||||
|
||||
The following steps work to set up a brand new Windows 10 installation for developing Renovate. If you already have some components installed, you can naturally skip them.
|
||||
The following steps work to set up a brand new Windows 10 installation for developing Renovate.
|
||||
If you already have some components installed, you can naturally skip them.
|
||||
|
||||
- Install [Git](https://git-scm.com/downloads). Make sure you've [configured your username and email](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup).
|
||||
- Install [Node.js LTS](https://nodejs.org/en/download/)
|
||||
|
|
@ -84,15 +85,19 @@ We use [Yarn](https://github.com/yarnpkg/yarn) so run `yarn install` to install
|
|||
|
||||
#### Build Renovate
|
||||
|
||||
Run `yarn build`. You should get no errors.
|
||||
Run `yarn build`.
|
||||
You should get no errors.
|
||||
|
||||
#### Verify tests
|
||||
|
||||
Run `yarn test`. You should see it pass with 100% test coverage. Make sure you've run `yarn build` first.
|
||||
Run `yarn test`.
|
||||
You should see it pass with 100% test coverage.
|
||||
Make sure you've run `yarn build` first.
|
||||
|
||||
#### Verify installation
|
||||
|
||||
Run `yarn start`. You should see this error:
|
||||
Run `yarn start`.
|
||||
You should see this error:
|
||||
|
||||
```
|
||||
Fatal error: No authentication found for platform https://api.github.com/ (github)
|
||||
|
|
@ -100,7 +105,8 @@ Fatal error: No authentication found for platform https://api.github.com/ (githu
|
|||
|
||||
## Platform Account Setup
|
||||
|
||||
Although it's possible to make small source code improvements without testing against a real repository, in most cases it's important that you run a "real" test on a repository before you submit a feature or fix. It's possible to do this against GitHub, GitLab or Bitbucket public servers.
|
||||
Although it's possible to make small source code improvements without testing against a real repository, in most cases it's important that you run a "real" test on a repository before you submit a feature or fix.
|
||||
It's possible to do this against GitHub, GitLab or Bitbucket public servers.
|
||||
|
||||
#### Register new account (optional)
|
||||
|
||||
|
|
@ -110,7 +116,8 @@ e.g. if your GitHub username is "alex88" then maybe you register "alex88-testing
|
|||
|
||||
#### Generate platform token
|
||||
|
||||
Once you have decided on your platform and account, log in and [generate a "Personal Access Token"](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) that can be used to authenticate Renovate. Select **repo** scope when generating the token.
|
||||
Once you have decided on your platform and account, log in and [generate a "Personal Access Token"](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) that can be used to authenticate Renovate.
|
||||
Select **repo** scope when generating the token.
|
||||
|
||||
#### Export platform token
|
||||
|
||||
|
|
@ -119,21 +126,29 @@ You are better off to instead export the Environment Variable `RENOVATE_TOKEN` f
|
|||
|
||||
#### Run against a real repo
|
||||
|
||||
To make sure everything is working, create a test repo in your account, e.g. like `https://github.com/r4harry/testrepo1`. Now, add a file called `.nvmrc` with the content `8.13.0`. Now run against the test repo you created, e.g. `yarn start r4harry/testrepo1`. If your token is set up correctly, you should find that it added a "Configure Renovate" PR inside the repo.
|
||||
To make sure everything is working, create a test repo in your account, e.g. like `https://github.com/r4harry/testrepo1`.
|
||||
Now, add a file called `.nvmrc` with the content `8.13.0`.
|
||||
Now run against the test repo you created, e.g. `yarn start r4harry/testrepo1`.
|
||||
If your token is set up correctly, you should find that it added a "Configure Renovate" PR inside the repo.
|
||||
|
||||
If this is working then in future you can create other test repos to verify your code changes against.
|
||||
|
||||
## Tests
|
||||
|
||||
You can run `yarn test` locally to test your code. We test all PRs using the same tests, run on CircleCI and Azure Pipelines. `yarn test` runs an `eslint` check, a `prettier` check, a `type` check and then all the unit tests using `jest`.
|
||||
You can run `yarn test` locally to test your code.
|
||||
We test all PRs using the same tests, run on CircleCI and Azure Pipelines. `yarn test` runs an `eslint` check, a `prettier` check, a `type` check and then all the unit tests using `jest`.
|
||||
|
||||
## Jest
|
||||
|
||||
You can run just the Jest unit tests by running `yarn jest`. You can also run just a subset of the Jest tests using file matching, e.g. `yarn jest composer` or `yarn jest workers/branch`. If you get a test failure due to a "snapshot" mismatch, and you are sure that you need to update the snapshot, then you can append `-u` to the end. e.g. `yarn jest composer -u` would update the saved snapshots for _all_ tests in `test/manager/composer/*`.
|
||||
You can run just the Jest unit tests by running `yarn jest`.
|
||||
You can also run just a subset of the Jest tests using file matching, e.g. `yarn jest composer` or `yarn jest workers/branch`.
|
||||
If you get a test failure due to a "snapshot" mismatch, and you are sure that you need to update the snapshot, then you can append `-u` to the end.
|
||||
e.g. `yarn jest composer -u` would update the saved snapshots for _all_ tests in `test/manager/composer/*`.
|
||||
|
||||
#### Prerequisites
|
||||
|
||||
You need to have Python with `mock` installed for all tests to pass. Python 3 includes `mock` so that approach is recommended.
|
||||
You need to have Python with `mock` installed for all tests to pass.
|
||||
Python 3 includes `mock` so that approach is recommended.
|
||||
|
||||
You also need to make sure that you don't have a local `.npmrc` file that overrides npm's default registry.
|
||||
|
||||
|
|
@ -144,12 +159,15 @@ Using `// istanbul ignore` is not ideal but sometimes is a pragmatic solution if
|
|||
|
||||
To view the current test coverage locally, open up `coverage/index.html` in your browser.
|
||||
|
||||
Do not let coverage put you off submitting a PR! Maybe we can help, or at least guide.
|
||||
Do not let coverage put you off submitting a PR!
|
||||
Maybe we can help, or at least guide.
|
||||
Also, it can be good to submit your PR as a work in progress (WIP) without tests first so that you can get a thumbs up from others about the changes, and write tests after.
|
||||
|
||||
#### Linting and formatting
|
||||
|
||||
We use [Prettier](https://github.com/prettier/prettier) for code formatting. If your code fails `yarn test` due to a `prettier` rule then run `yarn lint-fix` to fix it or most `eslint` errors automatically before running `yarn test` again. You usually shouldn't need to fix any Prettier errors manually.
|
||||
We use [Prettier](https://github.com/prettier/prettier) for code formatting.
|
||||
If your code fails `yarn test` due to a `prettier` rule then run `yarn lint-fix` to fix it or most `eslint` errors automatically before running `yarn test` again.
|
||||
You usually shouldn't need to fix any Prettier errors manually.
|
||||
|
||||
## Keeping your Renovate fork up to date
|
||||
|
||||
|
|
@ -186,15 +204,14 @@ The above will delete any existing `debug.log` and then save Renovate's output t
|
|||
|
||||
#### Adding configuration options
|
||||
|
||||
We wish to keep backwards-compatibility as often as possible, as well as make
|
||||
the code configurable, so most new functionality should be controllable via
|
||||
configuration options.
|
||||
We wish to keep backwards-compatibility as often as possible, as well as make the code configurable, so most new functionality should be controllable via configuration options.
|
||||
|
||||
If you wish to add one, add it to `lib/config/definitions.ts` and then add documentation to `website/docs/configuration-options.md`.
|
||||
|
||||
## Debugging
|
||||
|
||||
It's really easy to debug Renovate using Chrome's inspect tool. Try like this:
|
||||
It's really easy to debug Renovate using Chrome's inspect tool.
|
||||
Try like this:
|
||||
|
||||
1. Open `chrome://inspect` in Chrome, then click on "Open dedicated DevTools for Node"
|
||||
2. Add a `debugger;` statement somewhere in the source code where you want to start debugging
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
# Renovate Developer Docs
|
||||
|
||||
This directory is intended to provide documentation for developers/contributors on the Renovate project. For user-facing documentation - e.g. for how to configure Renovate as a user - please see https://docs.renovatebot.com
|
||||
This directory is intended to provide documentation for developers/contributors on the Renovate project.
|
||||
For user-facing documentation - e.g. for how to configure Renovate as a user - please see https://docs.renovatebot.com
|
||||
|
||||
If you would like to contribute to Renovate or get it running locally for some other reason, please check out [contributing.md](../../.github/contributing.md) for steps on how to set up the project locally.
|
||||
|
|
|
|||
|
|
@ -1,30 +1,20 @@
|
|||
# Preset configs
|
||||
|
||||
Renovate uses the term "presets" to refer to shareable config snippets, similar
|
||||
to ESLint. Unlike ESLint though:
|
||||
Renovate uses the term "presets" to refer to shareable config snippets, similar to ESLint.
|
||||
Unlike ESLint though:
|
||||
|
||||
- Presets may be as small as a list of package names, or as large as a full
|
||||
config
|
||||
- Presets may be as small as a list of package names, or as large as a full config
|
||||
- Shared config files can contain many presets
|
||||
|
||||
## Preset config URIs
|
||||
|
||||
In human-understandable form, the rules are:
|
||||
|
||||
- A full preset URI consists of package name, preset name, and preset
|
||||
parameters, such as `package:preset(param)`
|
||||
- If a package scope is specified and no package, then the package name is
|
||||
assumed to be `renovate-config`, e.g. `@rarkins:webapp` is expanded to
|
||||
`@rarkins/renovate-config:webapp`
|
||||
- If a non-scoped package is specified then it is assumed to have prefix
|
||||
`renovate-config-`. e.g. `rarkins:webapp` is expanded to
|
||||
`renovate-config-rarkins:webapp`
|
||||
- If a package name is specified and no preset name, then `default` is assumed,
|
||||
e.g. `@rarkins` expands in full to `@rarkins/renovate-config:default` and
|
||||
`rarkins` expands in full to `renovate-config-rarkins:default`
|
||||
- There is a special "default" namespace where no package name is necessary.
|
||||
e.g. `:webapp` (not the leading `:`) expands to
|
||||
`renovate-config-default:webapp`
|
||||
- A full preset URI consists of package name, preset name, and preset parameters, such as `package:preset(param)`
|
||||
- If a package scope is specified and no package, then the package name is assumed to be `renovate-config`, e.g. `@rarkins:webapp` is expanded to `@rarkins/renovate-config:webapp`
|
||||
- If a non-scoped package is specified then it is assumed to have prefix `renovate-config-`. e.g. `rarkins:webapp` is expanded to `renovate-config-rarkins:webapp`
|
||||
- If a package name is specified and no preset name, then `default` is assumed, e.g. `@rarkins` expands in full to `@rarkins/renovate-config:default` and `rarkins` expands in full to `renovate-config-rarkins:default`
|
||||
- There is a special "default" namespace where no package name is necessary. e.g. `:webapp` (not the leading `:`) expands to `renovate-config-default:webapp`
|
||||
|
||||
## Supported config syntax
|
||||
|
||||
|
|
@ -34,8 +24,7 @@ In human-understandable form, the rules are:
|
|||
@somescope
|
||||
```
|
||||
|
||||
This will resolve to use the preset `default` in the npm package
|
||||
`@somescope/renovate-config`.
|
||||
This will resolve to use the preset `default` in the npm package `@somescope/renovate-config`.
|
||||
|
||||
### Scoped with package name
|
||||
|
||||
|
|
@ -43,8 +32,7 @@ This will resolve to use the preset `default` in the npm package
|
|||
@somescope/somepackagename
|
||||
```
|
||||
|
||||
This will resolve to use the preset `default` in the npm package
|
||||
`@somescope/somepackagename`.
|
||||
This will resolve to use the preset `default` in the npm package `@somescope/somepackagename`.
|
||||
|
||||
### Scoped with preset name
|
||||
|
||||
|
|
@ -52,8 +40,7 @@ This will resolve to use the preset `default` in the npm package
|
|||
@somescope:webapp
|
||||
```
|
||||
|
||||
This will resolve to use the preset `webapp` in the npm package
|
||||
`@somescope/renovate-config`.
|
||||
This will resolve to use the preset `webapp` in the npm package `@somescope/renovate-config`.
|
||||
|
||||
### Scoped with params
|
||||
|
||||
|
|
@ -61,8 +48,7 @@ This will resolve to use the preset `webapp` in the npm package
|
|||
@somescope(eslint, stylelint)
|
||||
```
|
||||
|
||||
This will resolve to use the preset `default` in the npm package
|
||||
`@somescope/renovate-config` and pass the parameters `eslint` and `stylelint`.
|
||||
This will resolve to use the preset `default` in the npm package `@somescope/renovate-config` and pass the parameters `eslint` and `stylelint`.
|
||||
|
||||
### Scoped with preset name and params
|
||||
|
||||
|
|
@ -70,8 +56,7 @@ This will resolve to use the preset `default` in the npm package
|
|||
@somescope:webapp(eslint, stylelint)
|
||||
```
|
||||
|
||||
This will resolve to use the preset `webapp` in the npm package
|
||||
`@somescope/renovate-config` and pass the parameters `eslint` and `stylelint`.
|
||||
This will resolve to use the preset `webapp` in the npm package `@somescope/renovate-config` and pass the parameters `eslint` and `stylelint`.
|
||||
|
||||
### Scoped with package name and preset name
|
||||
|
||||
|
|
@ -79,8 +64,7 @@ This will resolve to use the preset `webapp` in the npm package
|
|||
@somescope/somepackagename:webapp
|
||||
```
|
||||
|
||||
This will resolve to use the preset `webapp` in the npm package
|
||||
`@somescope/somepackagename`.
|
||||
This will resolve to use the preset `webapp` in the npm package `@somescope/somepackagename`.
|
||||
|
||||
### Scoped with package name and preset name and params
|
||||
|
||||
|
|
@ -88,8 +72,7 @@ This will resolve to use the preset `webapp` in the npm package
|
|||
@somescope/somepackagename:webapp(eslint, stylelint)
|
||||
```
|
||||
|
||||
This will resolve to use the preset `webapp` in the npm package
|
||||
`@somescope/somepackagename` and pass the parameters `eslint` and `stylelint`.
|
||||
This will resolve to use the preset `webapp` in the npm package `@somescope/somepackagename` and pass the parameters `eslint` and `stylelint`.
|
||||
|
||||
### Non-scoped short with preset name
|
||||
|
||||
|
|
@ -99,8 +82,7 @@ Note: if using non-scoped packages, a preset name is mandatory.
|
|||
somepackagename:default
|
||||
```
|
||||
|
||||
This will resolve to use the preset `default` in the npm package
|
||||
`renovate-config-somepackagename`.
|
||||
This will resolve to use the preset `default` in the npm package `renovate-config-somepackagename`.
|
||||
|
||||
### Non-scoped short with preset name and params
|
||||
|
||||
|
|
@ -110,8 +92,7 @@ Note: if using non-scoped packages, a preset name is mandatory.
|
|||
somepackagename:default(eslint)
|
||||
```
|
||||
|
||||
This will resolve to use the preset `default` in the npm package
|
||||
`renovate-config-somepackagename` with param `eslint`.
|
||||
This will resolve to use the preset `default` in the npm package `renovate-config-somepackagename` with param `eslint`.
|
||||
|
||||
### Non-scoped full with preset name
|
||||
|
||||
|
|
@ -121,8 +102,7 @@ Note: if using non-scoped packages, a preset name is mandatory.
|
|||
renovate-config-somepackagename:default
|
||||
```
|
||||
|
||||
This will resolve to use the preset `default` in the npm package
|
||||
`renovate-config-somepackagename`.
|
||||
This will resolve to use the preset `default` in the npm package `renovate-config-somepackagename`.
|
||||
|
||||
### Non-scoped full with preset name and params
|
||||
|
||||
|
|
@ -132,5 +112,4 @@ Note: if using non-scoped packages, a preset name is mandatory.
|
|||
renovate-config-somepackagename:default(eslint)
|
||||
```
|
||||
|
||||
This will resolve to use the preset `default` in the npm package
|
||||
`renovate-config-somepackagename` and param `eslint`.
|
||||
This will resolve to use the preset `default` in the npm package `renovate-config-somepackagename` and param `eslint`.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,9 @@ description: Renovate's support for ESLint-like shareable configs
|
|||
|
||||
# Shareable Config Presets
|
||||
|
||||
Renovate's "config presets" are a convenient way to distribute config that is reused across multiple repositories. It is similar in design to `eslint`'s shareable configs, and can be used both for whole repository configs as well as for individual rules. They are defined using the `extends` array within config and may also be nested.
|
||||
Renovate's "config presets" are a convenient way to distribute config that is reused across multiple repositories.
|
||||
It is similar in design to `eslint`'s shareable configs, and can be used both for whole repository configs as well as for individual rules.
|
||||
They are defined using the `extends` array within config and may also be nested.
|
||||
|
||||
In short:
|
||||
|
||||
|
|
@ -40,19 +42,24 @@ The following namespace is used:
|
|||
- `gitlab>abc/foo`: gitlab repository `https://gitlab.com/abc/foo` and preset `default`
|
||||
- `gitlab>abc/foo:xyz`: gitlab repository `https://gitlab.com/abc/foo` and preset `xyz`
|
||||
|
||||
In general, GitHub or GitLab-based preset hosting is easier than npm because you avoid the "publish" step - simply commit preset code to the default branch and it will be picked up by Renovate the next time it runs. An additional benefit of using source code hosting is that the same token/authentication can be reused by Renovate in case you want to make your config private.
|
||||
In general, GitHub or GitLab-based preset hosting is easier than npm because you avoid the "publish" step - simply commit preset code to the default branch and it will be picked up by Renovate the next time it runs.
|
||||
An additional benefit of using source code hosting is that the same token/authentication can be reused by Renovate in case you want to make your config private.
|
||||
|
||||
## Example configs
|
||||
|
||||
An example of a small rule is `:preserveSemverRanges`, which has the description "Preserve (but continue to upgrade) any existing semver ranges". It simply sets the configuration option `rangeStrategy` to `replace`.
|
||||
An example of a small rule is `:preserveSemverRanges`, which has the description "Preserve (but continue to upgrade) any existing semver ranges".
|
||||
It simply sets the configuration option `rangeStrategy` to `replace`.
|
||||
|
||||
An example of a full config is `config:base`, which is Renovate's default configuration. It mostly uses Renovate config defaults but adds a few smart customisations such as grouping monorepo packages together.
|
||||
An example of a full config is `config:base`, which is Renovate's default configuration.
|
||||
It mostly uses Renovate config defaults but adds a few smart customisations such as grouping monorepo packages together.
|
||||
|
||||
Special note: the `:xyz` naming convention (with `:` prefix) is a special shorthand for the `default:` presets. i.e. `:xyz` is equivalent to `default:xyz`.
|
||||
Special note: the `:xyz` naming convention (with `:` prefix) is a special shorthand for the `default:` presets.
|
||||
i.e. `:xyz` is equivalent to `default:xyz`.
|
||||
|
||||
## How to Use Preset Configs
|
||||
|
||||
By default, the Renovate App's onboarding process will suggest `["config:base]"`. If you are self hosting then you must add `"onboardingConfig": { "extends": ["config:base"] }` to your bot's config.
|
||||
By default, the Renovate App's onboarding process will suggest `["config:base]"`.
|
||||
If you are self hosting then you must add `"onboardingConfig": { "extends": ["config:base"] }` to your bot's config.
|
||||
|
||||
A typical onboarding `renovate.json` will then look like this:
|
||||
|
||||
|
|
@ -62,7 +69,8 @@ A typical onboarding `renovate.json` will then look like this:
|
|||
}
|
||||
```
|
||||
|
||||
Let's say you wish to modify that default behaviour, such as to schedule Renovate to process upgrades only during non-office hours. In that case you could modify the default `renovate.json` to be like this:
|
||||
Let's say you wish to modify that default behaviour, such as to schedule Renovate to process upgrades only during non-office hours.
|
||||
In that case you could modify the default `renovate.json` to be like this:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -70,7 +78,8 @@ Let's say you wish to modify that default behaviour, such as to schedule Renovat
|
|||
}
|
||||
```
|
||||
|
||||
This makes use of the `schedules:` presets. To see all presets published by the Renovate team then browse the "Config Presets" section of [Renovate Docs](https://docs.renovatebot.com).
|
||||
This makes use of the `schedules:` presets.
|
||||
To see all presets published by the Renovate team then browse the "Config Presets" section of [Renovate Docs](https://docs.renovatebot.com).
|
||||
|
||||
## Preset Parameters
|
||||
|
||||
|
|
@ -101,17 +110,22 @@ Here is how you would use these in your Renovate config:
|
|||
]
|
||||
```
|
||||
|
||||
In short, the number of `{{argx}}` params in the definition is how many parameters you need to provide. Parameters must be strings, non-quoted, and separated by commas if there are more than one.
|
||||
In short, the number of `{{argx}}` params in the definition is how many parameters you need to provide.
|
||||
Parameters must be strings, non-quoted, and separated by commas if there are more than one.
|
||||
|
||||
If you find that you are repeating config a lot, you might consider publishing one of these types of parameterised presets yourself, or if you think your preset would be valuable for others, please contribute a PR to the Renovate repository.
|
||||
|
||||
## How to Publish Preset Configs
|
||||
|
||||
If you manage multiple repositories using Renovate and want the same custom config across all or most of them, then you might want to consider publishing your own preset config so that you can "extend" it in every applicable repository. That way when you want to change your Renovate configuration you can make the change in one location rather than having to copy/paste it to every repository individually.
|
||||
If you manage multiple repositories using Renovate and want the same custom config across all or most of them, then you might want to consider publishing your own preset config so that you can "extend" it in every applicable repository.
|
||||
That way when you want to change your Renovate configuration you can make the change in one location rather than having to copy/paste it to every repository individually.
|
||||
|
||||
Let's say that your username on npm and elsewhere is "fastcore". In that case, you can choose between publishing your preset config package as `@fastcore/renovate-config` or `renovate-config-fastcore`. Let's assume you choose `renovate-config-fastcore` as the package name:
|
||||
Let's say that your username on npm and elsewhere is "fastcore".
|
||||
In that case, you can choose between publishing your preset config package as `@fastcore/renovate-config` or `renovate-config-fastcore`.
|
||||
Let's assume you choose `renovate-config-fastcore` as the package name:
|
||||
|
||||
You then need to publish the `renovate-config-fastcore` package where the `package.json` contains the field `renovate-config` and then put your config under the field `default`. For example:
|
||||
You then need to publish the `renovate-config-fastcore` package where the `package.json` contains the field `renovate-config` and then put your config under the field `default`.
|
||||
For example:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -142,7 +156,8 @@ Note: if you prefer to publish using the namespace `@fastcore/renovate-config` t
|
|||
|
||||
## GitHub-hosted Presets
|
||||
|
||||
It is also possible to host your preset config using just a regular GitHub repository and without needing to publish it to npmjs. In such cases Renovate will simply look for a renovate.json file in the default branch, e.g. master.
|
||||
It is also possible to host your preset config using just a regular GitHub repository and without needing to publish it to npmjs.
|
||||
In such cases Renovate will simply look for a renovate.json file in the default branch, e.g. master.
|
||||
|
||||
To host your preset config on GitHub:
|
||||
|
||||
|
|
@ -154,11 +169,13 @@ To host your preset config on GitHub:
|
|||
"extends": ["github>rarkins/renovate-config"]
|
||||
```
|
||||
|
||||
From then on Renovate will use the renovate config from the preset repo's default branch. You do not need to add it as a devDependency or add any other files to the preset repo.
|
||||
From then on Renovate will use the renovate config from the preset repo's default branch.
|
||||
You do not need to add it as a devDependency or add any other files to the preset repo.
|
||||
|
||||
## GitLab-hosted Presets
|
||||
|
||||
It is also possible to host your preset config using just a regular GitLab repository and without needing to publish it to npmjs. In such cases Renovate will simply look for a renovate.json file in the default branch, (for now only the master branch is supported).
|
||||
It is also possible to host your preset config using just a regular GitLab repository and without needing to publish it to npmjs.
|
||||
In such cases Renovate will simply look for a renovate.json file in the default branch, (for now only the master branch is supported).
|
||||
|
||||
To host your preset config on GitLab:
|
||||
|
||||
|
|
@ -168,26 +185,36 @@ To host your preset config on GitLab:
|
|||
|
||||
## Local presets
|
||||
|
||||
Renovate also supports local presets, i.e. presets that are hosted on the same platform as the target repository. This is especially helpful in self-hosted scenarios where public presets cannot be used. Local presets are only supported on GitHub, GitLab and Bitbucket Server. Local presets are specified either by leaving out any prefix, e.g. `owner/name`, or explicitly by adding a `local>` prefix, e.g. `local>owner/name`. Renovate will determine the current platform and look up the preset from there.
|
||||
Renovate also supports local presets, i.e. presets that are hosted on the same platform as the target repository.
|
||||
This is especially helpful in self-hosted scenarios where public presets cannot be used.
|
||||
Local presets are only supported on GitHub, GitLab and Bitbucket Server.
|
||||
Local presets are specified either by leaving out any prefix, e.g. `owner/name`, or explicitly by adding a `local>` prefix, e.g. `local>owner/name`.
|
||||
Renovate will determine the current platform and look up the preset from there.
|
||||
|
||||
## Presets and Private Modules
|
||||
|
||||
Using your own preset config along with private npm modules can present a chicken and egg problem. You want to configure the encrypted token just once, which means in the preset. But you also probably want the preset to be private too, so how can the other repos reference it?
|
||||
Using your own preset config along with private npm modules can present a chicken and egg problem.
|
||||
You want to configure the encrypted token just once, which means in the preset.
|
||||
But you also probably want the preset to be private too, so how can the other repos reference it?
|
||||
|
||||
The answer is to host your preset using GitHub or GitLab - not npmjs - and make sure you have added the preset's repo to Renovate too. GitHub will then permit Renovate to access the preset repo whenever it is processing any other repos within the same account/org.
|
||||
The answer is to host your preset using GitHub or GitLab - not npmjs - and make sure you have added the preset's repo to Renovate too.
|
||||
GitHub will then permit Renovate to access the preset repo whenever it is processing any other repos within the same account/org.
|
||||
|
||||
## Contributing to presets
|
||||
|
||||
Have you configured a rule that you think others might benefit from? Please consider contributing it to the [Renovate](https://github.com/renovatebot/renovate) repository so that it gains higher visibility and saves others from reinventing the same thing.
|
||||
Have you configured a rule that you think others might benefit from?
|
||||
Please consider contributing it to the [Renovate](https://github.com/renovatebot/renovate) repository so that it gains higher visibility and saves others from reinventing the same thing.
|
||||
|
||||
## Organization level presets
|
||||
|
||||
Whenever repository onboarding happens, Renovate checks if the current user/group/org contains a default config to extend. It looks for:
|
||||
Whenever repository onboarding happens, Renovate checks if the current user/group/org contains a default config to extend.
|
||||
It looks for:
|
||||
|
||||
- A repository called `renovate-config` under the same user/group/org with either `default.json` or `renovate.json`, or
|
||||
- A repository named like `.{{platform}}` (e.g. `.github`) under the same user/group/org with `renovate-config.json`
|
||||
|
||||
If found, that repository's preset will be suggested as the the sole extended preset, and any existing `onboardingConfig` config will be ignored/overridden. For example the result may be:
|
||||
If found, that repository's preset will be suggested as the the sole extended preset, and any existing `onboardingConfig` config will be ignored/overridden.
|
||||
For example the result may be:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
|||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -9,39 +9,52 @@ This document describes how you can edit the branch names, commit messages, or P
|
|||
|
||||
## Branch Name
|
||||
|
||||
The branch name is very important for Renovate because it helps determine "grouping" of updates, and also makes it efficient when an existing PR needs to be updated with a newer version. Also, if you change branchPrefix and have some upgrades "ignored" (closed without merging) then you may see duplicate PRs opened with your new branch name.
|
||||
The branch name is very important for Renovate because it helps determine "grouping" of updates, and also makes it efficient when an existing PR needs to be updated with a newer version.
|
||||
Also, if you change branchPrefix and have some upgrades "ignored" (closed without merging) then you may see duplicate PRs opened with your new branch name.
|
||||
|
||||
`branchName` has a default value of `{{{branchPrefix}}}{{{additionalBranchPrefix}}}{{{branchTopic}}}`.
|
||||
|
||||
The most common type of branch name you will see looks like this: `renovate/react-16.x`. In this example, the `branchPrefix` is the default `renovate/`, `additionalBranchPrefix` is empty, and `branchTopic` is `react-16.x`.
|
||||
The most common type of branch name you will see looks like this: `renovate/react-16.x`.
|
||||
In this example, the `branchPrefix` is the default `renovate/`, `additionalBranchPrefix` is empty, and `branchTopic` is `react-16.x`.
|
||||
|
||||
Most people can leave `branchPrefix` as `renovate/` however if you prefer to have no forward slashes then you might pick `renovate-` instead. Please note that the onboarding PR is fixed to use `renovate/configure` however.
|
||||
Most people can leave `branchPrefix` as `renovate/` however if you prefer to have no forward slashes then you might pick `renovate-` instead.
|
||||
Please note that the onboarding PR is fixed to use `renovate/configure` however.
|
||||
|
||||
`additionalBranchPrefix` is optional and by default is empty for all JavaScript dependencies. We use `docker-` for all Docker updates, so you might see branches like `renovate/docker-ubuntu-16.x`.
|
||||
`additionalBranchPrefix` is optional and by default is empty for all JavaScript dependencies.
|
||||
We use `docker-` for all Docker updates, so you might see branches like `renovate/docker-ubuntu-16.x`.
|
||||
|
||||
`branchTopic` depends on the package manager and upgrade type, so you will see a lot of variety. It is also the one you might be most likely to want to change, but be careful and consider posting your config to https://github.com/renovateapp/config-help first.
|
||||
`branchTopic` depends on the package manager and upgrade type, so you will see a lot of variety.
|
||||
It is also the one you might be most likely to want to change, but be careful and consider posting your config to https://github.com/renovateapp/config-help first.
|
||||
|
||||
## Commit Message
|
||||
|
||||
Renovate is designed to have just a single commit per branch, for merging convenience. As such, that commitMessage should reflect the contents of the branch and usually be the same as the PR Title.
|
||||
Renovate is designed to have just a single commit per branch, for merging convenience.
|
||||
As such, that commitMessage should reflect the contents of the branch and usually be the same as the PR Title.
|
||||
|
||||
`commitMessage` has a default value of `{{commitMessagePrefix}} {{commitMessageAction}} {{commitMessageTopic}} {{commitMessageExtra}} {{commitMessageSuffix}}`, with the intention that you only edit some of those subcomponents.
|
||||
|
||||
`commitMessagePrefix` is usually not necessary to configure directly, and is used by Renovate if it needs to add a prefix due to Semantic Commit conventions. Do not touch it unless you know what you're doing.
|
||||
`commitMessagePrefix` is usually not necessary to configure directly, and is used by Renovate if it needs to add a prefix due to Semantic Commit conventions.
|
||||
Do not touch it unless you know what you're doing.
|
||||
|
||||
`commitMessageAction` is usually just 1 word, e.g. 'Update', 'Pin', 'Refresh', etc. It's usually also not necessary to edit, although maybe you prefer 'Upgrade' instead of 'Update'?
|
||||
`commitMessageAction` is usually just 1 word, e.g. 'Update', 'Pin', 'Refresh', etc.
|
||||
It's usually also not necessary to edit, although maybe you prefer 'Upgrade' instead of 'Update'?
|
||||
|
||||
`commitMessageTopic` is usually 2-3 words aimed to identify _what_ is being updated. e.g. it might be `dependency react` or `Docker image ubuntu`. You may want to edit this, but if you think your idea/requirement is a good one then maybe you can propose it to the project or publish it as a preset config for others with similar requirements.
|
||||
`commitMessageTopic` is usually 2-3 words aimed to identify _what_ is being updated. e.g. it might be `dependency react` or `Docker image ubuntu`.
|
||||
You may want to edit this, but if you think your idea/requirement is a good one then maybe you can propose it to the project or publish it as a preset config for others with similar requirements.
|
||||
|
||||
`commitMessageExtra` usually refers to the version being updated to. e.g. `to v16` for a major upgrade, or `to v16.0.3` for a patch update. It may also be empty in some cases, e.g. if the action/topic is `Pin Docker digests`.
|
||||
`commitMessageExtra` usually refers to the version being updated to. e.g. `to v16` for a major upgrade, or `to v16.0.3` for a patch update.
|
||||
It may also be empty in some cases, e.g. if the action/topic is `Pin Docker digests`.
|
||||
|
||||
`commitMessageSuffix` defaults to empty and is there for flexibility and future use. Maybe for `major` updates you always want the PR to end with `(MAJOR)`, for instance.
|
||||
`commitMessageSuffix` defaults to empty and is there for flexibility and future use.
|
||||
Maybe for `major` updates you always want the PR to end with `(MAJOR)`, for instance.
|
||||
|
||||
`commitBody` is used if you wish to add multi-line commit messages, such as for the `Signed-off-by` fields, or adding `[skip-ci]`, etc. It is appended to the generated `commitMessage`, separated by a newline.
|
||||
`commitBody` is used if you wish to add multi-line commit messages, such as for the `Signed-off-by` fields, or adding `[skip-ci]`, etc.
|
||||
It is appended to the generated `commitMessage`, separated by a newline.
|
||||
|
||||
## PR Title
|
||||
|
||||
Because commit messages should usually match with the PR title, the PR title template now defaults to `null` and inherits whatever is configured for `commitMessage`. If you have a requirement where `prTitle` should be different from `commitMessage`, then please raise a feature request for discussion.
|
||||
Because commit messages should usually match with the PR title, the PR title template now defaults to `null` and inherits whatever is configured for `commitMessage`.
|
||||
If you have a requirement where `prTitle` should be different from `commitMessage`, then please raise a feature request for discussion.
|
||||
|
||||
## PR Body
|
||||
|
||||
|
|
|
|||
|
|
@ -11,17 +11,21 @@ Once you have enabled Renovate on a repository, you will receive a "Configure Re
|
|||
|
||||
## No Risk Onboarding
|
||||
|
||||
Conveniently, Renovate will not make any changes to your repository or raise any further Pull Requests until after you _merge_ this initial Pull Request. So if there is anything about the Pull Request that you don't like or understand, take your time to read [documentation](https://docs.renovatebot.com) or ask questions in one of our support forums and merge the PR only once you're satisfied with the result. You can edit your Renovate configuration **within this `renovate/configure` branch** and Renovate will keep updating the description in the PR to match, so you can keep doing that until you're satisfied with the results.
|
||||
Conveniently, Renovate will not make any changes to your repository or raise any further Pull Requests until after you _merge_ this initial Pull Request.
|
||||
So if there is anything about the Pull Request that you don't like or understand, take your time to read [documentation](https://docs.renovatebot.com) or ask questions in one of our support forums and merge the PR only once you're satisfied with the result.
|
||||
You can edit your Renovate configuration **within this `renovate/configure` branch** and Renovate will keep updating the description in the PR to match, so you can keep doing that until you're satisfied with the results.
|
||||
|
||||
## Check for Warnings
|
||||
|
||||
If you have any Warnings or Errors listed, see if you need or want to make any changes to address them. If you do, then make them in your base branch (e.g. `master`) so that Renovate can recreate its Configure Renovate PR from it on its next cycle.
|
||||
If you have any Warnings or Errors listed, see if you need or want to make any changes to address them.
|
||||
If you do, then make them in your base branch (e.g. `master`) so that Renovate can recreate its Configure Renovate PR from it on its next cycle.
|
||||
|
||||
## Configuration Location
|
||||
|
||||
The Configure Renovate PR will include a `renovate.json` file in the root directory, with suggested default settings.
|
||||
|
||||
If you don't want to have an additional file (`renovate.json`) in your repository then you can instead add the same settings to a `"renovate"` section in your `package.json`, if you are already using this (e.g. JavaScript project). Any settings made in `package.json` will apply to the whole project (including other, nested `package.json` files).
|
||||
If you don't want to have an additional file (`renovate.json`) in your repository then you can instead add the same settings to a `"renovate"` section in your `package.json`, if you are already using this (e.g. JavaScript project).
|
||||
Any settings made in `package.json` will apply to the whole project (including other, nested `package.json` files).
|
||||
|
||||
Alternatively, if you prefer to use "dot files" then you can add the same JSON configuration to either a `.renovaterc` file or `.renovaterc.json` file instead of `renovate.json`.
|
||||
|
||||
|
|
|
|||
|
|
@ -5,73 +5,108 @@ description: The pros and cons of dependency pinning for JavaScript/npm
|
|||
|
||||
# Should you Pin your JavaScript Dependencies?
|
||||
|
||||
Once you start using a tool/service like Renovate, probably the biggest decision you need to make is whether to "pin" your dependencies instead of using semver ranges. The answer is "It's your choice", however we can certainly make some generalisations/recommendations to help you. Jump to the bottom conclusions if you get impatient.
|
||||
Once you start using a tool/service like Renovate, probably the biggest decision you need to make is whether to "pin" your dependencies instead of using semver ranges.
|
||||
The answer is "It's your choice", however we can certainly make some generalisations/recommendations to help you.
|
||||
Jump to the bottom conclusions if you get impatient.
|
||||
|
||||
## What is Dependency Pinning?
|
||||
|
||||
To ensure we're all talking about the same thing, it's important to define exactly what we mean by dependency "pinning".
|
||||
|
||||
Historically, projects use semver ranges in their `package.json`. For instance, if you run `npm install foobar` you will see an entry like `"foobar": "^1.1.0"` added to your `package.json`. Verbosely, this means "any foobar version greater than or equal to 1.1.0 but less than 2". Therefore the project will automatically use 1.1.1 if it's released, or 1.2.0, or 1.2.1, etc - meaning you will get not only patch updates but also feature (minor) releases too.
|
||||
Historically, projects use semver ranges in their `package.json`.
|
||||
For instance, if you run `npm install foobar` you will see an entry like `"foobar": "^1.1.0"` added to your `package.json`.
|
||||
Verbosely, this means "any foobar version greater than or equal to 1.1.0 but less than 2".
|
||||
Therefore the project will automatically use 1.1.1 if it's released, or 1.2.0, or 1.2.1, etc - meaning you will get not only patch updates but also feature (minor) releases too.
|
||||
|
||||
Another alternative is ranges like `"foobar": "~1.1.0"` which means "any foobar version greater than or equal to 1.1.0 but less than 1.2". This narrows the range to only patch updates to the 1.1 range.
|
||||
Another alternative is ranges like `"foobar": "~1.1.0"` which means "any foobar version greater than or equal to 1.1.0 but less than 1.2".
|
||||
This narrows the range to only patch updates to the 1.1 range.
|
||||
|
||||
If instead you "pin" your dependencies rather than use ranges, it means you use exact entries like `"foobar": "1.1.0"` which means "use only foobar version 1.1.0 and no other".
|
||||
|
||||
## Why use ranges?
|
||||
|
||||
For projects of any type, the main reason to use ranges is so that you can "automatically" get updated releases - which may even include security fixes. By "automatically", we mean that any time you run `npm install` you will get the very latest version matching your semver - assuming you're not using a lock file, that is.
|
||||
For projects of any type, the main reason to use ranges is so that you can "automatically" get updated releases - which may even include security fixes.
|
||||
By "automatically", we mean that any time you run `npm install` you will get the very latest version matching your semver - assuming you're not using a lock file, that is.
|
||||
|
||||
#### Tilde vs Caret
|
||||
|
||||
If you're familiar with the theory of semver, you might think that you only need to use tilde ranges (e.g. `"~1.1.0"`) to get bug fixes, rather than caret ranges (e.g. `"^1.1.0"`). This is true in theory but not in practice. The reality is that for most projects, fixes are not "backported" to previous minor releases, and minor releases themselves may include fixes. So for example release `1.2.0` may include one new feature and one fix, so if you stick with `1.1.0` then you will miss out on the fix as there will never be a `1.1.1` once `1.2.0` is already released. This is the _reality_ of most open source packages.
|
||||
If you're familiar with the theory of semver, you might think that you only need to use tilde ranges (e.g. `"~1.1.0"`) to get bug fixes, rather than caret ranges (e.g. `"^1.1.0"`).
|
||||
This is true in theory but not in practice.
|
||||
The reality is that for most projects, fixes are not "backported" to previous minor releases, and minor releases themselves may include fixes.
|
||||
So for example release `1.2.0` may include one new feature and one fix, so if you stick with `1.1.0` then you will miss out on the fix as there will never be a `1.1.1` once `1.2.0` is already released.
|
||||
This is the _reality_ of most open source packages.
|
||||
|
||||
#### Ranges for Libraries
|
||||
|
||||
A second reason for using ranges applies to "libraries" that are published as npm packages with the intention that they are used/`require()`'d by other packages. In this case, it is usually a bad idea to pin all your dependencies because it will introduce an unnecessarily narrow range (one release!) and cause most users of your package to bloat their `node_modules` with duplicates.
|
||||
A second reason for using ranges applies to "libraries" that are published as npm packages with the intention that they are used/`require()`'d by other packages.
|
||||
In this case, it is usually a bad idea to pin all your dependencies because it will introduce an unnecessarily narrow range (one release!) and cause most users of your package to bloat their `node_modules` with duplicates.
|
||||
|
||||
For example, you might have pinned `foobar` to version `1.1.0` and another author pinned his/her `foobar` to dependency to `1.2.2`. Any user of both your packages will end up with npm attempting to install two separate versions of `foobar`, which might not even work. Even if both projects use a service like Renovate to keep their pinned dependencies up to date with the very latest versions, it's still not a good idea - there will always be times when one package has updated/released before the other one and they will be out of sync. e.g. there might be a space of 30 minutes where your package specifies foobar `1.1.0` and the other one specifies `1.1.1` and your joint downstream users end up with a duplicate.
|
||||
For example, you might have pinned `foobar` to version `1.1.0` and another author pinned his/her `foobar` to dependency to `1.2.2`.
|
||||
Any user of both your packages will end up with npm attempting to install two separate versions of `foobar`, which might not even work.
|
||||
Even if both projects use a service like Renovate to keep their pinned dependencies up to date with the very latest versions, it's still not a good idea - there will always be times when one package has updated/released before the other one and they will be out of sync.
|
||||
e.g. there might be a space of 30 minutes where your package specifies foobar `1.1.0` and the other one specifies `1.1.1` and your joint downstream users end up with a duplicate.
|
||||
|
||||
## Why pin dependencies?
|
||||
|
||||
You mainly pin versions for certainty, and visibility. When you have a pinned version of each dependency in your `package.json`, you know exactly which version of each dependency is installed at any time. This benefits when upgrading versions as well as when rolling back in case of problems. Note: we'll cover lock files later, don't worry.
|
||||
You mainly pin versions for certainty, and visibility.
|
||||
When you have a pinned version of each dependency in your `package.json`, you know exactly which version of each dependency is installed at any time.
|
||||
This benefits when upgrading versions as well as when rolling back in case of problems.
|
||||
Note: we'll cover lock files later, don't worry.
|
||||
|
||||
#### Upgrading pinned versions
|
||||
|
||||
Let's say that a "faulty" version `1.2.0` of `foobar` is released and it breaks one of your tests.
|
||||
|
||||
If you were using default caret semver ranges, then your `master` branch is now "broken" because its `package.json` says that any version 1.x above 1.1.0 is acceptable, and npm will choose the latest (`1.2.0`). You would need to manually check and work out which dependency caused the failure (`foobar` may not have been the only dependency to have "automatically" upgraded since the last time your tests passed) and then you would need to pin the dependency yourself to stop `npm` installing `1.2.0`.
|
||||
If you were using default caret semver ranges, then your `master` branch is now "broken" because its `package.json` says that any version 1.x above 1.1.0 is acceptable, and npm will choose the latest (`1.2.0`).
|
||||
You would need to manually check and work out which dependency caused the failure (`foobar` may not have been the only dependency to have "automatically" upgraded since the last time your tests passed) and then you would need to pin the dependency yourself to stop `npm` installing `1.2.0`.
|
||||
|
||||
Consider the same situation if instead you were _pinning_ dependency versions. Your `master` would not be broken because it's pinned to `foobar@1.1.0` - instead you'd just have a Pull Request for upgrading to `foobar@1.2.0` which would fail. You'd know not to merge it and can wait for `foobar@1.2.1` or later when it's fixed. Therefore you know exactly what you're running and you know exactly what failed - you have great "visibility".
|
||||
Consider the same situation if instead you were _pinning_ dependency versions.
|
||||
Your `master` would not be broken because it's pinned to `foobar@1.1.0` - instead you'd just have a Pull Request for upgrading to `foobar@1.2.0` which would fail.
|
||||
You'd know not to merge it and can wait for `foobar@1.2.1` or later when it's fixed.
|
||||
Therefore you know exactly what you're running and you know exactly what failed - you have great "visibility".
|
||||
|
||||
Now consider a similar theoretical scenario where `foobar@1.2.0` is faulty but it is _not_ caught by any of your automated tests. This is more common and more dangerous.
|
||||
Now consider a similar theoretical scenario where `foobar@1.2.0` is faulty but it is _not_ caught by any of your automated tests.
|
||||
This is more common and more dangerous.
|
||||
|
||||
If you were using semver ranges then this new version of `foobar` will likely be deployed to production automatically one day, sometime after which you notice errors and realise you need to fix it. Like before, you need to manually work out which dependency caused it - assuming you guess correctly that it was a new dependency version at fault - and pin it manually by editing `package.json` one dependency at a time.
|
||||
If you were using semver ranges then this new version of `foobar` will likely be deployed to production automatically one day, sometime after which you notice errors and realise you need to fix it.
|
||||
Like before, you need to manually work out which dependency caused it - assuming you guess correctly that it was a new dependency version at fault - and pin it manually by editing `package.json` one dependency at a time.
|
||||
|
||||
Alternatively, if you were instead pinning `foobar` then you would receive a PR for `foobar@1.2.0` which awaits your approval. So first of all, you can choose to read the release notes and/or visually inspect the branch yourself before merging, hopefully saving you from pushing this faulty code to production.
|
||||
Alternatively, if you were instead pinning `foobar` then you would receive a PR for `foobar@1.2.0` which awaits your approval.
|
||||
So first of all, you can choose to read the release notes and/or visually inspect the branch yourself before merging, hopefully saving you from pushing this faulty code to production.
|
||||
|
||||
If you did not catch the fault before merging, you are still better off with a pinned version. If you discover something wrong in production, you can easily "roll back" commits in your development environment until you find which rollback fixes the problem. Then you can simply revert that commit (reversing `foobar@1.1.0` -> `foobar@1.2.0`) and push that to `master`. When the next release of `foobar` comes out (e.g. `1.2.1`) you will be prompted with a new PR and hopefully inspect it carefully this time before merge!
|
||||
If you did not catch the fault before merging, you are still better off with a pinned version.
|
||||
If you discover something wrong in production, you can easily "roll back" commits in your development environment until you find which rollback fixes the problem.
|
||||
Then you can simply revert that commit (reversing `foobar@1.1.0` -> `foobar@1.2.0`) and push that to `master`.
|
||||
When the next release of `foobar` comes out (e.g. `1.2.1`) you will be prompted with a new PR and hopefully inspect it carefully this time before merge!
|
||||
|
||||
As you can see in the above, pinning dependencies makes your build more consistent and predictable as a developer.
|
||||
|
||||
#### Downside of pinned dependencies - upgrade "noise"
|
||||
|
||||
The one major downside to your development workflow of pinning dependencies is the potential for increased "noise" in your repository. As mentioned above, you can expect to receive Pull Requests whenever there is a new version of your dependencies available. Depending on how many repositories you maintain, and how many dependencies are in each, you may find this default approach to be overwhelming (e.g. waking up to 10 new Pull Requests each day).
|
||||
The one major downside to your development workflow of pinning dependencies is the potential for increased "noise" in your repository.
|
||||
As mentioned above, you can expect to receive Pull Requests whenever there is a new version of your dependencies available.
|
||||
Depending on how many repositories you maintain, and how many dependencies are in each, you may find this default approach to be overwhelming (e.g. waking up to 10 new Pull Requests each day).
|
||||
|
||||
## Reducing the "noise" of dependency updates
|
||||
|
||||
The increased volume of Pull Requests for upgrading dependencies may be considered by some to be undesirable "noise" in their day. To some extent this is simply a trade-off for having your dependencies pinned and predictable, however there are also ways you can reduce this noise while still gaining the majority of the benefits:
|
||||
The increased volume of Pull Requests for upgrading dependencies may be considered by some to be undesirable "noise" in their day.
|
||||
To some extent this is simply a trade-off for having your dependencies pinned and predictable, however there are also ways you can reduce this noise while still gaining the majority of the benefits:
|
||||
|
||||
##### Pull Request automerging
|
||||
|
||||
There are some dependencies that either (a) don't have the potential to break something in production, or (b) are fully tested by your tests.
|
||||
|
||||
For example, it's very hard for `eslint` to break anything in production. If your build/tests pass, then you are fine. Therefore you should consider enabling automerge for all lint packages to save yourself the pointless click when you manually approve them each time. In this case you might wake up to 5/10 of your overnight Pull Requests having already merged themselves.
|
||||
For example, it's very hard for `eslint` to break anything in production. If your build/tests pass, then you are fine.
|
||||
Therefore you should consider enabling automerge for all lint packages to save yourself the pointless click when you manually approve them each time.
|
||||
In this case you might wake up to 5/10 of your overnight Pull Requests having already merged themselves.
|
||||
|
||||
Another example of a good candidate for automerging might be a database driver like `node-postgres` (`pg` on npm), if you have 100% test coverage of your API. In that case if the `pg` package has a minor or patch update and passes all tests then you may as well merge it automatically if you were not going to do a manual inspection anyway.
|
||||
Another example of a good candidate for automerging might be a database driver like `node-postgres` (`pg` on npm), if you have 100% test coverage of your API.
|
||||
In that case if the `pg` package has a minor or patch update and passes all tests then you may as well merge it automatically if you were not going to do a manual inspection anyway.
|
||||
|
||||
##### Branch automerging
|
||||
|
||||
In the above suggestion of Pull Request automerging, you might still find it annoying if you receive GitHub Notifications for every PR that is created and merged. In that case, you could set `automergeType` to `branch`, which means Renovate will:
|
||||
In the above suggestion of Pull Request automerging, you might still find it annoying if you receive GitHub Notifications for every PR that is created and merged.
|
||||
In that case, you could set `automergeType` to `branch`, which means Renovate will:
|
||||
|
||||
- Create a new branch for testing
|
||||
- Wait until after tests have completed
|
||||
|
|
@ -82,7 +117,8 @@ With this approach, updates will be essentially "silent" - causing no notificati
|
|||
|
||||
##### Scheduling
|
||||
|
||||
Although it can feel satisfying to receive updates "immediately" when they're available, the reality is that you usually don't _need_ updates so frequently. And worse still, npm package versions that are less than 24 hours [can be unpublished](https://blog.npmjs.org/post/141905368000/changes-to-npms-unpublish-policy), which would really break your build if you've pinned to a version that no longer exists.
|
||||
Although it can feel satisfying to receive updates "immediately" when they're available, the reality is that you usually don't _need_ updates so frequently.
|
||||
And worse still, npm package versions that are less than 24 hours [can be unpublished](https://blog.npmjs.org/post/141905368000/changes-to-npms-unpublish-policy), which would really break your build if you've pinned to a version that no longer exists.
|
||||
|
||||
So to reduce the interruptions of automated dependency updates, consider putting Renovate on a schedule, such as:
|
||||
|
||||
|
|
@ -91,11 +127,13 @@ So to reduce the interruptions of automated dependency updates, consider putting
|
|||
|
||||
##### Grouping related packages
|
||||
|
||||
Although it's good to isolate each dependency update for ease of troubleshooting, there are times when the extra noise isn't worth it, or when packages naturally belong together anyway (such as all `babel` packages). You can add a package rule in our Renovate configuration to group these together and you'll get just one branch combined even if multiple packages have updates available.
|
||||
Although it's good to isolate each dependency update for ease of troubleshooting, there are times when the extra noise isn't worth it, or when packages naturally belong together anyway (such as all `babel` packages).
|
||||
You can add a package rule in our Renovate configuration to group these together and you'll get just one branch combined even if multiple packages have updates available.
|
||||
|
||||
## Pinning Dependencies and Lock Files
|
||||
|
||||
Since both `yarn` and `npm@5` both support lock files, it's a common question to ask "Why should I pin dependencies if I'm already using a lock file?". It's a good question!
|
||||
Since both `yarn` and `npm@5` both support lock files, it's a common question to ask "Why should I pin dependencies if I'm already using a lock file?".
|
||||
It's a good question!
|
||||
|
||||
|
||||
|
||||
|
|
@ -117,19 +155,33 @@ The lock file has only delayed the inevitable problem, and provides much less vi
|
|||
|
||||
If the `package.json` contains a range, and a new in-range version is released that would break the build, then essentially your `package.json` is in a state of "broken", even if the lock file is still holding things together.
|
||||
|
||||
The upside is that the lockfile will hold back `foobar` to `1.1.0` unless it's forced to upgrade, so the break is postponed. The downside is _how_ you will discover the break eventually.
|
||||
The upside is that the lockfile will hold back `foobar` to `1.1.0` unless it's forced to upgrade, so the break is postponed.
|
||||
The downside is _how_ you will discover the break eventually.
|
||||
|
||||
The easiest case is if for some reason you _need_ to upgrade `foobar`, e.g. for a new feature it contains, so you might run something like `yarn upgrade foobar`. Then you might either discover the break during your development or when you push your new development to CI for testing. In this case, hopefully you'll guess it's `foobar` that broke it and not your own code.
|
||||
The easiest case is if for some reason you _need_ to upgrade `foobar`, e.g. for a new feature it contains, so you might run something like `yarn upgrade foobar`.
|
||||
Then you might either discover the break during your development or when you push your new development to CI for testing.
|
||||
In this case, hopefully you'll guess it's `foobar` that broke it and not your own code.
|
||||
|
||||
Alternatively, maybe someone thinks "This lockfile is probably really out of date and might be missing some essential patches" and decides to `yarn upgrade` the whole thing in one go. No doubt the diff will be full of green and red as many direct and indirect dependencies will have changed versions. Then it's pushed to CI for testing, fails, and you have to guess which of the changes caused it until you eventually narrow it down to `foobar`. This might require even manually looking through the lock file diffs line by line. Maybe dep `blahblah` also broke at the same time, to make it even harder.
|
||||
Alternatively, maybe someone thinks "This lockfile is probably really out of date and might be missing some essential patches" and decides to `yarn upgrade` the whole thing in one go.
|
||||
No doubt the diff will be full of green and red as many direct and indirect dependencies will have changed versions.
|
||||
Then it's pushed to CI for testing, fails, and you have to guess which of the changes caused it until you eventually narrow it down to `foobar`.
|
||||
This might require even manually looking through the lock file diffs line by line.
|
||||
Maybe dep `blahblah` also broke at the same time, to make it even harder.
|
||||
|
||||
By ceding control of direct dependency versions to the lock file, you have lost the ability to _know_ when things are updated. You also may be missing out on really important patches you're not even aware of, because they're "in range" yet locked back to vulnerable or buggy versions in the lock file.
|
||||
By ceding control of direct dependency versions to the lock file, you have lost the ability to _know_ when things are updated.
|
||||
You also may be missing out on really important patches you're not even aware of, because they're "in range" yet locked back to vulnerable or buggy versions in the lock file.
|
||||
|
||||
Reconsider the same scenario if `foobar` had instead been pinned to `1.1.0` in `package.json` The (broken) upgrade to `1.2.0` would have been explicitly proposed to you via a Renovate PR, you would see the break, and know that the version is bad. Meanwhile you could be upgrading all the other essential fixes of other dependencies without worrying about `foobar`. You could even be running `yarn upgrade` regularly to be getting _indirect_ package updates in the lockfile and seeing if everything still passes.
|
||||
Reconsider the same scenario if `foobar` had instead been pinned to `1.1.0` in `package.json`.
|
||||
The (broken) upgrade to `1.2.0` would have been explicitly proposed to you via a Renovate PR, you would see the break, and know that the version is bad.
|
||||
Meanwhile you could be upgrading all the other essential fixes of other dependencies without worrying about `foobar`.
|
||||
You could even be running `yarn upgrade` regularly to be getting _indirect_ package updates in the lockfile and seeing if everything still passes.
|
||||
|
||||
Therefore, the lock file does not solve the same semver problems that pinning solves - but it compliments it. For this reason our usual recommendation using a lock file regardless of whether you pin dependencies or not, and pinning even if you have a lock file.
|
||||
Therefore, the lock file does not solve the same semver problems that pinning solves - but it compliments it.
|
||||
For this reason our usual recommendation using a lock file regardless of whether you pin dependencies or not, and pinning even if you have a lock file.
|
||||
|
||||
Don't forget though that our motto is "Flexible, so you don't need to be", so go ahead and configure however you want. Also, we're open to ideas for how to make lock file updates more "visible" too. e.g. are you interested in a Renovate feature where you get a lockfile-only PR any time a direct dependency gets an in-range update?
|
||||
Don't forget though that our motto is "Flexible, so you don't need to be", so go ahead and configure however you want.
|
||||
Also, we're open to ideas for how to make lock file updates more "visible" too.
|
||||
e.g. are you interested in a Renovate feature where you get a lockfile-only PR any time a direct dependency gets an in-range update?
|
||||
|
||||
## What about indirect/sub-dependencies?
|
||||
|
||||
|
|
@ -139,11 +191,19 @@ A good argument made by [@LinusU](https://github.com/LinusU) is:
|
|||
|
||||
> Because of this, I personally think that pinning dependencies just creates a false sense of security, and that using a lock file is superior in every way.
|
||||
|
||||
It is true that pinning applies only to direct dependencies, and "indirect" dependencies typically count for a lot more in total in your lockfile than direct. e.g. those 30 ones that Express relies on.
|
||||
It is true that pinning applies only to direct dependencies, and "indirect" dependencies typically count for a lot more in total in your lockfile than direct.
|
||||
e.g. those 30 ones that Express relies on.
|
||||
|
||||
Does pinning give you "increased" security? Undeniably. The question is not whether it does, but whether that increased security comes at a cost (e.g. "noise"). But Linus also points out that a _false_ sense of security is a cost too.
|
||||
Does pinning give you "increased" security?
|
||||
Undeniably.
|
||||
The question is not whether it does, but whether that increased security comes at a cost (e.g. "noise").
|
||||
But Linus also points out that a _false_ sense of security is a cost too.
|
||||
|
||||
Don't forget that there is some form of transitive trust too. You need to pick your direct dependencies carefully, and which versions of them you use. Hopefully in doing that you pick dependencies partly for how well _they_ look after their own dependencies and versions (e.g. do they have good enough test coverage, do they use something like Renovate to keep updated, etc?). So the reality is that even if 90% of the entries in your lock file are indirect dependencies, those are ones you have somewhat "delegated" responsibility for to your dependencies. e.g. I'd hope that Express are even better at watching their deps for breaks than I am, to use the example above.
|
||||
Don't forget that there is some form of transitive trust too.
|
||||
You need to pick your direct dependencies carefully, and which versions of them you use.
|
||||
Hopefully in doing that you pick dependencies partly for how well _they_ look after their own dependencies and versions (e.g. do they have good enough test coverage, do they use something like Renovate to keep updated, etc?).
|
||||
So the reality is that even if 90% of the entries in your lock file are indirect dependencies, those are ones you have somewhat "delegated" responsibility for to your dependencies.
|
||||
e.g. I'd hope that Express are even better at watching their deps for breaks than I am, to use the example above.
|
||||
|
||||
But certainly "does it give a false sense of security" is not a question we can really answer quantifiably.
|
||||
|
||||
|
|
@ -156,10 +216,12 @@ We recommend:
|
|||
3. Node.js-only libraries can consider pinning all dependencies, because application size/duplicate dependencies are not as much a concern in Node.js compared to the browser. Of course, don't do that if your library is a micro one likely to be consumed in disk-sensitive environments.
|
||||
4. Use a lock file.
|
||||
|
||||
As noted earlier, when you pin dependencies then you will see an increase in the raw volume of dependency updates, compared to if you use ranges. If/when this starts bothering you, add Renovate rules to reduce the volume, such as scheduling updates, grouping them, or automerging "safe" ones.
|
||||
As noted earlier, when you pin dependencies then you will see an increase in the raw volume of dependency updates, compared to if you use ranges.
|
||||
If/when this starts bothering you, add Renovate rules to reduce the volume, such as scheduling updates, grouping them, or automerging "safe" ones.
|
||||
|
||||
## References
|
||||
|
||||
This is a "living" document and we plan to update it whenever we think of something new or someone makes a valid point we've missed or misunderstood. [GitHub Location](https://github.com/renovatebot/renovate/blob/master/website/docs/dependency-pinning.md)
|
||||
This is a "living" document and we plan to update it whenever we think of something new or someone makes a valid point we've missed or misunderstood.
|
||||
[GitHub Location](https://github.com/renovatebot/renovate/blob/master/website/docs/dependency-pinning.md)
|
||||
|
||||
Updated 2018-01-19 after [excellent feedback on lockfiles](https://github.com/commitizen/cz-conventional-changelog-default-export/pull/4#issuecomment-358038966) by [@LinusU](https://github.com/LinusU)
|
||||
|
|
|
|||
|
|
@ -21,13 +21,18 @@ Renovate supports upgrading dependencies in various types of Docker definition f
|
|||
|
||||
## Preservation of Version Precision
|
||||
|
||||
Renovate by default will preserve the precision of Docker images. For example if the existing image is `node:12.1` then Renovate would only propose upgrades to `node:12.2` or `node:12.3` and not to more specified versions like `node:12.2.0` or `node:12.3.0`. Renovate does not yet support "pinning" an imprecise version to a precise version, e.g. from `node:12.2` to `node:12.2.0`, however it's a feature we'd like to implement one day.
|
||||
Renovate by default will preserve the precision of Docker images.
|
||||
For example if the existing image is `node:12.1` then Renovate would only propose upgrades to `node:12.2` or `node:12.3` and not to more specified versions like `node:12.2.0` or `node:12.3.0`.
|
||||
Renovate does not yet support "pinning" an imprecise version to a precise version, e.g. from `node:12.2` to `node:12.2.0`, however it's a feature we'd like to implement one day.
|
||||
|
||||
## Version compatibility
|
||||
|
||||
Although suffixes in semver indicate pre-releases (e.g. `v1.2.0-alpha.2`), in Docker they typically indicate compatibility, e.g. `12.2.0-alpine`. Renovate defaults to assuming suffixes indicate compatibility so will never _change_ it. e.g. `12.1.0-alpine` might get updated to `12.1.1-alpine` but never `12.1.1` or `12.1.1-stretch`.
|
||||
Although suffixes in semver indicate pre-releases (e.g. `v1.2.0-alpha.2`), in Docker they typically indicate compatibility, e.g. `12.2.0-alpine`.
|
||||
Renovate defaults to assuming suffixes indicate compatibility so will never _change_ it.
|
||||
e.g. `12.1.0-alpine` might get updated to `12.1.1-alpine` but never `12.1.1` or `12.1.1-stretch`.
|
||||
|
||||
If this behaviour does not suit a particular package you have, Renovate allows you to customize the `versioning` in use. For example, if you have a Docker image `foo/bar` that sticks to semver versioning and you need Renovate to understand that suffixes indicate pre-releases versions and not compatibility, then you could configure this package rule:
|
||||
If this behaviour does not suit a particular package you have, Renovate allows you to customize the `versioning` in use.
|
||||
For example, if you have a Docker image `foo/bar` that sticks to semver versioning and you need Renovate to understand that suffixes indicate pre-releases versions and not compatibility, then you could configure this package rule:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -41,7 +46,8 @@ If this behaviour does not suit a particular package you have, Renovate allows y
|
|||
}
|
||||
```
|
||||
|
||||
Another example is the official `python` image, which follows `pep440` versioning. You can configure that with another package rule:
|
||||
Another example is the official `python` image, which follows `pep440` versioning.
|
||||
You can configure that with another package rule:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -55,43 +61,60 @@ Another example is the official `python` image, which follows `pep440` versionin
|
|||
}
|
||||
```
|
||||
|
||||
If traditional versioning doesn't work, consider using Renovate's built-in `loose` `versioning`. It essentially just does a best effort sort of versions, regardless of whether they contain letters or digits.
|
||||
If traditional versioning doesn't work, consider using Renovate's built-in `loose` `versioning`.
|
||||
It essentially just does a best effort sort of versions, regardless of whether they contain letters or digits.
|
||||
|
||||
Finally, if you use a Docker image that follows a versioning approach not captured by one of our existing versionings, and which `loose` sorts incorrectly, you could see if the `regex` `versioning` can work. It uses regex capture group syntax to let you specify which part of the version string is major, minor, patch, pre-release, or compatibility. See the docs for `versioning` for documentation/examples of `regex` versioning in action.
|
||||
Finally, if you use a Docker image that follows a versioning approach not captured by one of our existing versionings, and which `loose` sorts incorrectly, you could see if the `regex` `versioning` can work.
|
||||
It uses regex capture group syntax to let you specify which part of the version string is major, minor, patch, pre-release, or compatibility.
|
||||
See the docs for `versioning` for documentation/examples of `regex` versioning in action.
|
||||
|
||||
## Digest Pinning
|
||||
|
||||
Pinning your Docker images to an exact digest is recommended for reasons of **immutability**. In short: pin to digests so every time you `pull`, you get the same content.
|
||||
Pinning your Docker images to an exact digest is recommended for reasons of **immutability**.
|
||||
In short: pin to digests so every time you `pull`, you get the same content.
|
||||
|
||||
If your experience with dependency versioning comes from a place like JavaScript/npm, you might be used to exact versions being immutable, e.g. if you specify a version like `2.0.1` then you and your colleagues will always get the exact same "code". What you may not expect is that Docker's tags are not immutable versions even if they look like a version. e.g. you probably expect that `node:8` and `node:8.9` will change over time, but you might incorrectly assume that `node:8.9.0` would never change. Although it probably _shouldn't_, the reality is that any Docker image tag _can_ change content, and potentially break.
|
||||
If your experience with dependency versioning comes from a place like JavaScript/npm, you might be used to exact versions being immutable, e.g. if you specify a version like `2.0.1` then you and your colleagues will always get the exact same "code".
|
||||
What you may not expect is that Docker's tags are not immutable versions even if they look like a version.
|
||||
e.g. you probably expect that `node:8` and `node:8.9` will change over time, but you might incorrectly assume that `node:8.9.0` would never change.
|
||||
Although it probably _shouldn't_, the reality is that any Docker image tag _can_ change content, and potentially break.
|
||||
|
||||
Using a Docker digest as the image's primary identifier instead of Docker tag will achieve immutability but as a human it's quite inconvenient to deal with strings like `FROM node@sha256:552348163f074034ae75643c01e0ba301af936a898d778bb4fc16062917d0430`. The good news is that, as a human you no longer need to manually update such digests once you have Renovate on the job.
|
||||
Using a Docker digest as the image's primary identifier instead of Docker tag will achieve immutability but as a human it's quite inconvenient to deal with strings like `FROM node@sha256:552348163f074034ae75643c01e0ba301af936a898d778bb4fc16062917d0430`.
|
||||
The good news is that, as a human you no longer need to manually update such digests once you have Renovate on the job.
|
||||
|
||||
Also, to retain some human-friendliness, Renovate will actually retain the tag in the `FROM` line too, e.g. `FROM node:8@sha256:552348163f074034ae75643c01e0ba301af936a898d778bb4fc16062917d0430`. Read on to see how Renovate keeps it up-to-date.
|
||||
Also, to retain some human-friendliness, Renovate will actually retain the tag in the `FROM` line too, e.g. `FROM node:8@sha256:552348163f074034ae75643c01e0ba301af936a898d778bb4fc16062917d0430`.
|
||||
Read on to see how Renovate keeps it up-to-date.
|
||||
|
||||
## Digest Updating
|
||||
|
||||
If you have followed our advice to go from tags like `node:8` to `node:8@sha256:552348163f074034ae75643c01e0ba301af936a898d778bb4fc16062917d0430`, then you are likely to receive Renovate PRs whenever the `node:8` image is updated on Docker Hub.
|
||||
|
||||
Previously this would have been "invisible" to you - one day you pull code that represents `node:8.9.0` and the next day you get `node:8.9.1`. But you can never be sure, especially as Docker caches. Perhaps some of your colleagues or worst still your build machine are stuck on an older version with a security vulnerability.
|
||||
Previously this would have been "invisible" to you - one day you pull code that represents `node:8.9.0` and the next day you get `node:8.9.1`.
|
||||
But you can never be sure, especially as Docker caches.
|
||||
Perhaps some of your colleagues or worst still your build machine are stuck on an older version with a security vulnerability.
|
||||
|
||||
Instead, you will now receive these updates via Pull Requests, or perhaps committed directly to your repository if you enable branch automerge for convenience. This ensures everyone on the team gets the latest versions and is in sync.
|
||||
Instead, you will now receive these updates via Pull Requests, or perhaps committed directly to your repository if you enable branch automerge for convenience.
|
||||
This ensures everyone on the team gets the latest versions and is in sync.
|
||||
|
||||
## Version Upgrading
|
||||
|
||||
Renovate also supports _upgrading_ versions in Docker tags, e.g. from `node:8.9.0` to `node:8.9.1` or `node:8.9` to `node:8.10`. If your tags looks like a version, Renovate will upgrade it like a version.
|
||||
Renovate also supports _upgrading_ versions in Docker tags, e.g. from `node:8.9.0` to `node:8.9.1` or `node:8.9` to `node:8.10`.
|
||||
If your tags looks like a version, Renovate will upgrade it like a version.
|
||||
|
||||
Thanks to this, you may wish to change the way you tag your image dependencies to be more specific, e.g. change from `node:8` to `node:8.9.1` so that every Renovate PR will be more human friendly, e.g. you can know that you are getting a PR because `node` upgraded from `8.9.1` to `8.9.2` and not because `8.9.1` somehow changed.
|
||||
|
||||
Currently, Renovate will upgrade minor/patch versions (e.g. from `8.9.0` to `8.9.1`) by default, but not upgrade major versions. If you wish to enable major versions then add the preset `docker:enableMajor` to your `extends` array in your `renovate.json`.
|
||||
Currently, Renovate will upgrade minor/patch versions (e.g. from `8.9.0` to `8.9.1`) by default, but not upgrade major versions.
|
||||
If you wish to enable major versions then add the preset `docker:enableMajor` to your `extends` array in your `renovate.json`.
|
||||
|
||||
Renovate has a some Docker-specific intelligence when it comes to versions. For example:
|
||||
Renovate has a some Docker-specific intelligence when it comes to versions.
|
||||
For example:
|
||||
|
||||
## Configuring/Disabling
|
||||
|
||||
If you wish to make changes that apply to all Docker managers, then add them to the `docker` config object. Note though that this is not foolproof, because some managers like `circleci` and `ansible` support multiple datasources so do not inherit from the `docker` config object.
|
||||
If you wish to make changes that apply to all Docker managers, then add them to the `docker` config object.
|
||||
Note though that this is not foolproof, because some managers like `circleci` and `ansible` support multiple datasources so do not inherit from the `docker` config object.
|
||||
|
||||
If you wish to override Docker settings for one particular type of manager, use that manager's config object instead. For example. to disable digest updates for Docker Compose only but leave them for other managers like `Dockerfile`, you would add this:
|
||||
If you wish to override Docker settings for one particular type of manager, use that manager's config object instead.
|
||||
For example, to disable digest updates for Docker Compose only but leave them for other managers like `Dockerfile`, you would add this:
|
||||
|
||||
```json
|
||||
"docker-compose": {
|
||||
|
|
@ -128,7 +151,8 @@ Add `"default:pinDigestsDisabled"` to your `extends` array.
|
|||
|
||||
##### Automerge digest updates
|
||||
|
||||
Add `"default:automergeDigest"` to your `extends` array. Also add `"default:automergeBranchPush"` if you wish for these to be committed directly to your base branch without raising a PR first.
|
||||
Add `"default:automergeDigest"` to your `extends` array.
|
||||
Also add `"default:automergeBranchPush"` if you wish for these to be committed directly to your base branch without raising a PR first.
|
||||
|
||||
##### Registry authentication
|
||||
|
||||
|
|
@ -146,7 +170,8 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
It is possible to add additional host rules following the [documentation](https://docs.renovatebot.com/configuration-options/#hostrules). For example if you have some images you host yourself that are password protected and also some images you pull from Docker Hub without authentication then you can configure for a specific Docker host like this:
|
||||
It is possible to add additional host rules following the [documentation](https://docs.renovatebot.com/configuration-options/#hostrules).
|
||||
For example if you have some images you host yourself that are password protected and also some images you pull from Docker Hub without authentication then you can configure for a specific Docker host like this:
|
||||
|
||||
```js
|
||||
module.exports = {
|
||||
|
|
|
|||
|
|
@ -9,8 +9,7 @@ description: Frequently Asked Questions for Renovate Configuration
|
|||
|
||||
Renovate will:
|
||||
|
||||
- Look for configuration options in a configuration file (e.g. `renovate.json`) and in each
|
||||
`package.json` file
|
||||
- Look for configuration options in a configuration file (e.g. `renovate.json`) and in each `package.json` file
|
||||
- Find and process all package files (e.g. `package.json`, `package.js`, `Dockerfile`, etc) in each repository
|
||||
- Use separate branches/PR for each dependency
|
||||
- Use separate branches for each _major_ version of each dependency
|
||||
|
|
@ -23,10 +22,8 @@ Renovate will:
|
|||
|
||||
### Use an alternative branch for Pull Request target
|
||||
|
||||
If for example your repository default branch is `master` but your Pull Requests
|
||||
should target branch `next`, then you can configure this via the `baseBranches`
|
||||
configuration option. To do this, add this line to the `renovate.json` in the
|
||||
_default_ branch (i.e. `master` in this example).
|
||||
If for example your repository default branch is `master` but your Pull Requests should target branch `next`, then you can configure this via the `baseBranches` configuration option.
|
||||
To do this, add this line to the `renovate.json` in the _default_ branch (i.e. `master` in this example).
|
||||
|
||||
```
|
||||
{
|
||||
|
|
@ -42,16 +39,14 @@ See the dedicated [Private npm module support](/private-modules/) page.
|
|||
|
||||
### Control renovate's schedule
|
||||
|
||||
Renovate itself will run as often as its administrator has configured it (e.g.
|
||||
hourly, daily, etc). But you may wish to update certain repositories less often,
|
||||
or even specific packages at a different schedule.
|
||||
Renovate itself will run as often as its administrator has configured it (e.g. hourly, daily, etc).
|
||||
But you may wish to update certain repositories less often, or even specific packages at a different schedule.
|
||||
|
||||
If you want to control the days of the week or times of day that renovate
|
||||
updates packages, use the `timezone` and `schedule` configuration options.
|
||||
If you want to control the days of the week or times of day that renovate updates packages, use the `timezone` and `schedule` configuration options.
|
||||
|
||||
By default, Renovate schedules will use the UTC timezone.
|
||||
This can be overridden in global config. Finally, it can be
|
||||
overridden on a per-repository basis too, e.g.:
|
||||
This can be overridden in global config.
|
||||
Finally, it can be overridden on a per-repository basis too, e.g.:
|
||||
|
||||
```
|
||||
"timezone": "America/Los_Angeles",
|
||||
|
|
@ -60,10 +55,8 @@ overridden on a per-repository basis too, e.g.:
|
|||
The timezone must be one of the valid
|
||||
[IANA time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
||||
|
||||
Now that your timezone is set, you can define days of week or hours of the day
|
||||
in which renovate will make changes. For this we rely on text parsing of the
|
||||
library [later](https://bunkat.github.io/later/parsers.html#text) and its
|
||||
concepts of "days", "time_before", and "time_after".
|
||||
Now that your timezone is set, you can define days of week or hours of the day in which renovate will make changes.
|
||||
For this we rely on text parsing of the library [later](https://bunkat.github.io/later/parsers.html#text) and its concepts of "days", "time_before", and "time_after".
|
||||
|
||||
Example scheduling:
|
||||
|
||||
|
|
@ -75,8 +68,7 @@ before 5:00am
|
|||
on friday and saturday
|
||||
```
|
||||
|
||||
This scheduling feature can be particularly useful for "noisy" packages that are
|
||||
updated frequently, such as `aws-sdk`.
|
||||
This scheduling feature can be particularly useful for "noisy" packages that are updated frequently, such as `aws-sdk`.
|
||||
|
||||
To restrict `aws-sdk` to only weekly updates, you could add this package rule:
|
||||
|
||||
|
|
@ -89,8 +81,8 @@ To restrict `aws-sdk` to only weekly updates, you could add this package rule:
|
|||
]
|
||||
```
|
||||
|
||||
Note that schedule must be in the form of an array, even if only one schedule is
|
||||
present. Multiple entries in the array means "or".
|
||||
Note that schedule must be in the form of an array, even if only one schedule is present.
|
||||
Multiple entries in the array means "or".
|
||||
|
||||
### Disable renovate for certain dependency types
|
||||
|
||||
|
|
@ -98,8 +90,7 @@ Define a packageRules entry which has the dependency type(s) in `depTypeList` an
|
|||
|
||||
### Use a single branch/PR for all dependency upgrades
|
||||
|
||||
Add a configuration for configuration option `groupName` set to value `"all"`,
|
||||
at the top level of your `renovate.json` or `package.json`.
|
||||
Add a configuration for configuration option `groupName` set to value `"all"`, at the top level of your `renovate.json` or `package.json`.
|
||||
|
||||
### Use separate branches per dependency, but not one per major release
|
||||
|
||||
|
|
@ -111,12 +102,13 @@ Set configuration option `rangeStrategy` to `"replace"`.
|
|||
|
||||
### Keep lock files (including sub-dependencies) up-to-date, even when `package.json` hasn't changed
|
||||
|
||||
This is enabled by default, but its schedule is set to `["before 5am on monday"]`. If you want it more frequently, then update the `schedule` field
|
||||
inside the `lockFileMaintenance` object.
|
||||
This is enabled by default, but its schedule is set to `["before 5am on monday"]`.
|
||||
If you want it more frequently, then update the `schedule` field inside the `lockFileMaintenance` object.
|
||||
|
||||
### Wait until tests have passed before creating the PR
|
||||
|
||||
Set configuration option `prCreation` to `"status-success"`. Failing branches will never get a Pull Request created until they eventually pass.
|
||||
Set configuration option `prCreation` to `"status-success"`.
|
||||
Failing branches will never get a Pull Request created until they eventually pass.
|
||||
|
||||
### Wait until tests have passed before creating a PR, but create the PR even if they fail
|
||||
|
||||
|
|
@ -150,8 +142,7 @@ e.g.
|
|||
|
||||
### Apply a rule, but only for packages starting with `abc`
|
||||
|
||||
Do the same as above, but instead of using `packageNames`, use `packagePatterns`
|
||||
and a regex. e.g.
|
||||
Do the same as above, but instead of using `packageNames`, use `packagePatterns` and a regex. e.g.
|
||||
|
||||
```
|
||||
"packageRules": [
|
||||
|
|
@ -177,8 +168,7 @@ As above, but apply a `groupName`, e.g.
|
|||
|
||||
### Change the default branch name, commit message, PR title or PR description
|
||||
|
||||
Set the `branchName`, `commitMessage`, `prTitle` or `prBody` configuration
|
||||
options:
|
||||
Set the `branchName`, `commitMessage`, `prTitle` or `prBody` configuration options:
|
||||
|
||||
```
|
||||
"branchName": "vroom/{{depName}}-{{newMajor}}.x",
|
||||
|
|
@ -188,26 +178,21 @@ options:
|
|||
|
||||
### Automatically merge passing Pull Requests
|
||||
|
||||
Set configuration option `autoMerge` to `true`. Nest it inside config objects `patch` or `minor` if you want it to apply to certain types only.
|
||||
Set configuration option `autoMerge` to `true`.
|
||||
Nest it inside config objects `patch` or `minor` if you want it to apply to certain types only.
|
||||
|
||||
### Separate patch releases from minor releases
|
||||
|
||||
Renovate's default behaviour is to separate major and minor releases, while
|
||||
patch releases are also consider "minor". For example if you were running
|
||||
`q@0.8.7` you would receive one branch for the minor update to `q@0.9.7` and a
|
||||
second for the major update to `q@1.4.1`.
|
||||
Renovate's default behaviour is to separate major and minor releases, while patch releases are also consider "minor".
|
||||
For example if you were running `q@0.8.7` you would receive one branch for the minor update to `q@0.9.7` and a second for the major update to `q@1.4.1`.
|
||||
|
||||
If you set the configuration option `separateMinorPatch` to `true`, or you
|
||||
configure `automerge` to have value `"patch"`, then Renovate will then separate
|
||||
patch releases as well. For example, if you did this when running `q@0.8.7` then
|
||||
you'd receive three PRs - for `q@0.8.13`, `q@0.9.7` and `q@1.4.1`.
|
||||
If you set the configuration option `separateMinorPatch` to `true`, or you configure `automerge` to have value `"patch"`, then Renovate will then separate patch releases as well.
|
||||
For example, if you did this when running `q@0.8.7` then you'd receive three PRs - for `q@0.8.13`, `q@0.9.7` and `q@1.4.1`.
|
||||
|
||||
Of course, most people don't want _more_ PRs, so you would probably want to
|
||||
utilise this feature to make less work for yourself instead. As an example, you
|
||||
might:
|
||||
Of course, most people don't want _more_ PRs, so you would probably want to utilise this feature to make less work for yourself instead.
|
||||
As an example, you might:
|
||||
|
||||
- Update patch updates daily and automerge if they pass tests
|
||||
- Update minor and major updates weekly
|
||||
|
||||
The result of this would hopefully be that you barely notice Renovate during the
|
||||
week while still getting the benefits of patch updates.
|
||||
The result of this would hopefully be that you barely notice Renovate during the week, while still getting the benefits of patch updates.
|
||||
|
|
|
|||
|
|
@ -21,18 +21,22 @@ Renovate supports upgrading dependencies in `go.mod` files and their accompanyin
|
|||
|
||||
## Enabling Go Modules Updating
|
||||
|
||||
Go Modules updating is on by default in Renovate Bot. To install Renovate Bot itself, either enable the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) for self-hosted.
|
||||
Go Modules updating is on by default in Renovate Bot.
|
||||
To install Renovate Bot itself, either enable the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) for self-hosted.
|
||||
|
||||
## Technical Details
|
||||
|
||||
#### Module Tidying
|
||||
|
||||
Go Modules tidying is not enabled by default, and so is opt-in via the [`postUpdateOptions`](https://docs.renovatebot.com/configuration-options/#postupdateoptions) config option. The reason for this is that a `go mod tidy` command may make changes to `go.mod` and `go.sum` that are completely unrelated to the updated module(s) in the PR, and so may be confusing to some users.
|
||||
Go Modules tidying is not enabled by default, and so is opt-in via the [`postUpdateOptions`](https://docs.renovatebot.com/configuration-options/#postupdateoptions) config option.
|
||||
The reason for this is that a `go mod tidy` command may make changes to `go.mod` and `go.sum` that are completely unrelated to the updated module(s) in the PR, and so may be confusing to some users.
|
||||
|
||||
#### Module Vendoring
|
||||
|
||||
Vendoring of Go Modules is done automatically if `vendor/modules.txt` is present. Renovate will commit all files changed within the `vendor/` folder.
|
||||
Vendoring of Go Modules is done automatically if `vendor/modules.txt` is present.
|
||||
Renovate will commit all files changed within the `vendor/` folder.
|
||||
|
||||
#### Go binary version
|
||||
|
||||
Currently, Renovate will try to keep up with the very latest version of `go`, and it is not configurable. It is planned though to support a configurable version of `go` per-repository soon.
|
||||
Currently, Renovate will try to keep up with the very latest version of `go`, and it is not configurable.
|
||||
It is planned though to support a configurable version of `go` per-repository soon.
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@ The only choice you need to make is whether to run Renovate on:
|
|||
|
||||
|
||||
|
||||
Renovate will silently ignore any repositories that don't have known package files, as well as any forks, so it's OK to install for all, however most people choose to select which repositories to include. Unfortunately GitHub doesn't yet offer a "select all except X,Y,Z" so instead you need to individually select all that you want if you don't choose the install into all repositories option.
|
||||
Renovate will silently ignore any repositories that don't have known package files, as well as any forks, so it's OK to install for all, however most people choose to select which repositories to include.
|
||||
Unfortunately GitHub doesn't yet offer a "select all except X,Y,Z" so instead you need to individually select all that you want if you don't choose the install into all repositories option.
|
||||
|
||||
Once you're done selecting repositories for Renovate to run on, click the green Install button at the bottom of the page and Renovate will be enabled for those repositories and start the onboarding process.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,8 @@ description: How to install the Renovate GitLab App
|
|||
|
||||
### Overview
|
||||
|
||||
WhiteSource Renovate runs as the user [@renovate-bot](https://gitlab.com/renovate-bot) on [gitlab.com](https://gitlab.com). To enable the hosted WhiteSource Renovate App on your GitLab.com project, you can do any of the following:
|
||||
WhiteSource Renovate runs as the user [@renovate-bot](https://gitlab.com/renovate-bot) on [gitlab.com](https://gitlab.com).
|
||||
To enable the hosted WhiteSource Renovate App on your GitLab.com project, you can do any of the following:
|
||||
|
||||
- Add [@renovate-bot](https://gitlab.com/renovate-bot) as a Developer directly to each project, or
|
||||
- Add [@renovate-bot](https://gitlab.com/renovate-bot) to a team that has Developer access to the project
|
||||
|
|
@ -51,17 +52,20 @@ WhiteSource Renovate is free for both public and private repositories, so no pay
|
|||
|
||||
Renovate needs a Personal Access Token configured in order to be able to fetch release notes from github.com repositories.
|
||||
|
||||
Although open source repositories are public, GitHub's API applies strict rate limiting to unauthenticated requests, so Renovate will not attempt to fetch unless it can detect a token. To fetch without a token would risk getting requests denied, which could in turn result in confusing inconsistencies in Pull or Merge Requests, including bodies which flip flop between release notes and none.
|
||||
Although open source repositories are public, GitHub's API applies strict rate limiting to unauthenticated requests, so Renovate will not attempt to fetch unless it can detect a token.
|
||||
To fetch without a token would risk getting requests denied, which could in turn result in confusing inconsistencies in Pull or Merge Requests, including bodies which flip flop between release notes and none.
|
||||
|
||||
#### Generate a Personal Access Token
|
||||
|
||||
Any read-only, public-only Personal Access Token for github.com will work.
|
||||
|
||||
While logged in, go to [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new). Add a note like "renovate release notes" and then generate the token - no further permissions are required.
|
||||
While logged in, go to [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new).
|
||||
Add a note like "renovate release notes" and then generate the token - no further permissions are required.
|
||||
|
||||
#### Configuring the Token
|
||||
|
||||
Visit [https://renovatebot.com/encrypt](https://renovatebot.com/encrypt), paste your token into "Raw value", and then click "Encrypt". Configure the resulting value into your renovate config or preset like this:
|
||||
Visit [https://renovatebot.com/encrypt](https://renovatebot.com/encrypt), paste your token into "Raw value", and then click "Encrypt".
|
||||
Configure the resulting value into your renovate config or preset like this:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -95,11 +99,13 @@ User tokens are passed with API calls to Renovate's backend to verify identity b
|
|||
|
||||
##### Installing for all projects
|
||||
|
||||
Unlike on GitHub, it is not possible to have the option to install Renovate on "all repositories now and in the future". To do this would require Renovate to store the user's token and this is not something we want to do.
|
||||
Unlike on GitHub, it is not possible to have the option to install Renovate on "all repositories now and in the future".
|
||||
To do this would require Renovate to store the user's token and this is not something we want to do.
|
||||
|
||||
##### Detecting new projects
|
||||
|
||||
Currently there is no detection mechanism in the backend scheduler to determine when Renovate has been added to a new project, so the onboarding MR won't appear instantly. Instead, the new project should be picked up during hourly scheduled runs.
|
||||
Currently there is no detection mechanism in the backend scheduler to determine when Renovate has been added to a new project, so the onboarding MR won't appear instantly.
|
||||
Instead, the new project should be picked up during hourly scheduled runs.
|
||||
|
||||
##### Auto merging pull requests
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ description: Java versions support in Renovate
|
|||
|
||||
# Java Dependency Updates
|
||||
|
||||
Renovate can update the version used in Gradle and Maven projects. This includes libraries and plugins.
|
||||
Renovate can update the version used in Gradle and Maven projects.
|
||||
This includes libraries and plugins.
|
||||
|
||||
## Gradle
|
||||
|
||||
|
|
@ -23,7 +24,8 @@ Renovate does not support:
|
|||
|
||||
### How It Works
|
||||
|
||||
Renovate uses a plugin to search and extract versions from projects. They are then looked up using Maven datasources and patched into PRs the usual way.
|
||||
Renovate uses a plugin to search and extract versions from projects.
|
||||
They are then looked up using Maven datasources and patched into PRs the usual way.
|
||||
|
||||
## Maven
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Datasources
|
||||
|
||||
Once Renovate's Managers are done scanning files and extracting dependencies, they will assign a `datasource` to each so that Renovate then knows how to search for new versions. You do not need to ever configure/override Datasources directly, but you may use them in `packageRules` to configure other aspects of Renovate's behavior, e.g.
|
||||
Once Renovate's Managers are done scanning files and extracting dependencies, they will assign a `datasource` to each so that Renovate then knows how to search for new versions.
|
||||
You do not need to ever configure/override Datasources directly, but you may use them in `packageRules` to configure other aspects of Renovate's behavior, e.g.
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Managers
|
||||
|
||||
Renovate is based around the concept of "package managers", or "managers" for short. These range from traditional package managers like npm, Bundler and Composer through to less traditional concepts like CircleCI or Travis config files.
|
||||
Renovate is based around the concept of "package managers", or "managers" for short.
|
||||
These range from traditional package managers like npm, Bundler and Composer through to less traditional concepts like CircleCI or Travis config files.
|
||||
|
||||
The goal of Renovate is to detect and maintain all third party dependencies in your repositories, through the use of managers.
|
||||
|
||||
|
|
@ -13,11 +14,13 @@ The goal of Renovate is to detect and maintain all third party dependencies in y
|
|||
|
||||
### File Matching
|
||||
|
||||
Most managers have a default `fileMatch` array. `fileMatch` is an array of Regular Expression strings used to match against the repository file list.
|
||||
Most managers have a default `fileMatch` array.
|
||||
`fileMatch` is an array of Regular Expression strings used to match against the repository file list.
|
||||
|
||||
#### Managers with no default fileMatch
|
||||
|
||||
Some managers have no default `fileMatch`, because they have no file naming convention that would let Renovate intelligently filter them. In such a case, the manager will be effectively disabled until you configure a `fileMatch` value, e.g. like the following:
|
||||
Some managers have no default `fileMatch`, because they have no file naming convention that would let Renovate intelligently filter them.
|
||||
In such a case, the manager will be effectively disabled until you configure a `fileMatch` value, e.g. like the following:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -41,7 +44,10 @@ If the default `fileMatch` value for a manager does not match against one of you
|
|||
|
||||
#### Ignoring files that match the default fileMatch
|
||||
|
||||
Note: Renovate will _extend_ the existing `fileMatch`, meaning you don't need to include the default values like `Dockerfile` in your own array. In other words, the values are "additive". If a manager matches a file that you _don't_ want it to, ignore it using the `ignorePaths` configuration option. Also, if you ever find that Renovate is _not_ matching a file name that you're certain it should, be sure to check that you your preset config isn't the cause of it. The `config:base` preset ignores common test and example directory names, for example.
|
||||
Note: Renovate will _extend_ the existing `fileMatch`, meaning you don't need to include the default values like `Dockerfile` in your own array.
|
||||
In other words, the values are "additive". If a manager matches a file that you _don't_ want it to, ignore it using the `ignorePaths` configuration option.
|
||||
Also, if you ever find that Renovate is _not_ matching a file name that you're certain it should, be sure to check that you your preset config isn't the cause of it.
|
||||
The `config:base` preset ignores common test and example directory names, for example.
|
||||
|
||||
### Enabling and Disabling Managers
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,12 @@
|
|||
# Versioning
|
||||
|
||||
Once Managers have extracted dependencies, and Datasources have located available versions, then Renovate makes use of "Versioning" schemes to perform sorting and filtering of results. This is necessary because different managers use different types of numbering/versioning, e.g. `1.0.0-beta.1` in `npm` and `1.0.0b1` in Python.
|
||||
Once Managers have extracted dependencies, and Datasources have located available versions, then Renovate makes use of "Versioning" schemes to perform sorting and filtering of results.
|
||||
This is necessary because different managers use different types of numbering/versioning, e.g. `1.0.0-beta.1` in `npm` and `1.0.0b1` in Python.
|
||||
|
||||
## Configuring Versioning
|
||||
|
||||
There are times when you may need to manually configure/override the `versioning` value for a particular dependency. You generally won't have a need for this in ecosystems with strict versioning enforcement like `npm`, but you might often need it for ecosystems like Docker where versioning is barely a "convention". e.g.
|
||||
There are times when you may need to manually configure/override the `versioning` value for a particular dependency.
|
||||
You generally won't have a need for this in ecosystems with strict versioning enforcement like `npm`, but you might often need it for ecosystems like Docker where versioning is barely a "convention". e.g.
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
|||
|
|
@ -5,17 +5,27 @@ description: How to reduce the "noise" associated with module updates
|
|||
|
||||
# Noise Reduction
|
||||
|
||||
Generally, the first reaction people have to automated dependency updates like Renovate is "oh great/feel the power of automation". The next reaction a few days or weeks later is often "this is getting overwhelming". Indeed, if you leave Renovate on its default settings of raising a PR every single time any dependency receives any update.. you will get a lot of PRs and related notifications. This document will give you some ideas of how to reduce the amount of "noise" in your repository and the Pros/Cons of each.
|
||||
Generally, the first reaction people have to automated dependency updates like Renovate is "oh great/feel the power of automation".
|
||||
The next reaction a few days or weeks later is often "this is getting overwhelming".
|
||||
Indeed, if you leave Renovate on its default settings of raising a PR every single time any dependency receives any update.. you will get a lot of PRs and related notifications.
|
||||
This document will give you some ideas of how to reduce the amount of "noise" in your repository and the Pros/Cons of each.
|
||||
|
||||
Of course, please keep in mind that people's definitions of "noise" may differ. For some people, it's noisy only if they get a notification or email from GitHub. For others, too many commits in their `master` branch may be "noise". In other words, your mileage may vary. Please contact the author if you have any ideas on this topic!
|
||||
Of course, please keep in mind that people's definitions of "noise" may differ.
|
||||
For some people, it's noisy only if they get a notification or email from GitHub.
|
||||
For others, too many commits in their `master` branch may be "noise".
|
||||
In other words, your mileage may vary.
|
||||
Please contact the author if you have any ideas on this topic!
|
||||
|
||||
## Package Grouping
|
||||
|
||||
To reduce noise, you can reduce the number of updates in total, and a good way to do that is via intelligent grouping of related packages.
|
||||
|
||||
As an example, our default `":app"` and `":library"` [presets](/config-presets/) include the rule `"group:monorepos"`, which means that "sibling" packages from known monorepos will always be grouped into the same branch/PR by renovate. For example, all `@angular/*` packages that are updated at the same time will be raised in a "Renovate angular monorepo packages" PR. And every package in the React monorepo will be grouped together in a React monorepo PR too.
|
||||
As an example, our default `":app"` and `":library"` [presets](/config-presets/) include the rule `"group:monorepos"`, which means that "sibling" packages from known monorepos will always be grouped into the same branch/PR by renovate.
|
||||
For example, all `@angular/*` packages that are updated at the same time will be raised in a "Renovate angular monorepo packages" PR.
|
||||
And every package in the React monorepo will be grouped together in a React monorepo PR too.
|
||||
|
||||
You may wish to take this further, for example you might want to group together all packages related to `eslint`, even if they come from separate repositories/authors. In that case you might add config like this:
|
||||
You may wish to take this further, for example you might want to group together all packages related to `eslint`, even if they come from separate repositories/authors.
|
||||
In that case you might add config like this:
|
||||
|
||||
```json
|
||||
"packageRules": [
|
||||
|
|
@ -28,17 +38,27 @@ You may wish to take this further, for example you might want to group together
|
|||
|
||||
By setting `packagePatterns` to "eslint", it means that any package with ESLint anywhere in its name will be grouped into a `renovate/eslint` branch and related PR.
|
||||
|
||||
**Caution**: Any time you group dependencies together, you naturally increase the chance that the branch will have an error ("break" your build). When you have more than one package upgrade in a PR, it's going to take you longer to work out which one broke than if they were all in separate PRs. Also, you will be held up upgrading all those dependencies until they all pass. If you weren't grouping, then you could keep upgrading all dependencies except the one that fails, instead of being held up. You will also have less flexibility about what to do when one or more in the group have a major upgrade and may break the others.
|
||||
**Caution**: Any time you group dependencies together, you naturally increase the chance that the branch will have an error ("break" your build).
|
||||
When you have more than one package upgrade in a PR, it's going to take you longer to work out which one broke than if they were all in separate PRs.
|
||||
Also, you will be held up upgrading all those dependencies until they all pass.
|
||||
If you weren't grouping, then you could keep upgrading all dependencies except the one that fails, instead of being held up.
|
||||
You will also have less flexibility about what to do when one or more in the group have a major upgrade and may break the others.
|
||||
|
||||
## Scheduling Renovate
|
||||
|
||||
On its own, the Renovate CLI tool runs once and then exits. Hence it only runs as often as its administrator sets it to (e.g. via `cron`). For the [Renovate app on GitHub](https://github.com/apps/renovate), it currently runs continuously using a job queue that gets refreshed hourly, or when you make relevant commits to your repository. Therefore, you can expect to get PRs at any time of the day, i.e. soon after versions are published to npm.
|
||||
On its own, the Renovate CLI tool runs once and then exits.
|
||||
Hence it only runs as often as its administrator sets it to (e.g. via `cron`).
|
||||
For the [Renovate app on GitHub](https://github.com/apps/renovate), it currently runs continuously using a job queue that gets refreshed hourly, or when you make relevant commits to your repository.
|
||||
Therefore, you can expect to get PRs at any time of the day, i.e. soon after versions are published to npm.
|
||||
|
||||
Receiving PRs at any hour can increase the feeling of being "overwhelmed" by updates and possibly interrupt your flow during working hours, so many Renovate users also consider reducing Renovate's schedule to be outside their normal working hours, for example weeknights and weekends. This is achievable by configuring `schedule` in your Renovate config and optionally `timezone` (Renovate's default time zone is UTC, so you may find it easier to write schedules if you override `timezone` to your local one).
|
||||
Receiving PRs at any hour can increase the feeling of being "overwhelmed" by updates and possibly interrupt your flow during working hours, so many Renovate users also consider reducing Renovate's schedule to be outside their normal working hours, for example weeknights and weekends.
|
||||
This is achievable by configuring `schedule` in your Renovate config and optionally `timezone` (Renovate's default time zone is UTC, so you may find it easier to write schedules if you override `timezone` to your local one).
|
||||
|
||||
Another example of adjusting schedules to fit with your workflow might be if your company performs releases every Monday. In that case, you might schedule Renovate to run every Tuesday after midnight to pick up new dependency updates that you can test over the following week before the next release.
|
||||
Another example of adjusting schedules to fit with your workflow might be if your company performs releases every Monday.
|
||||
In that case, you might schedule Renovate to run every Tuesday after midnight to pick up new dependency updates that you can test over the following week before the next release.
|
||||
|
||||
**Caution**: You need to make sure you leave yourself and Renovate enough time in a week to actually get all your updating and merging done. There are multiple reasons why Renovate may need to "recreate" PRs after you merge another:
|
||||
**Caution**: You need to make sure you leave yourself and Renovate enough time in a week to actually get all your updating and merging done.
|
||||
There are multiple reasons why Renovate may need to "recreate" PRs after you merge another:
|
||||
|
||||
1. Conflict with `package.json` (sometimes)
|
||||
2. Conflict with lock files (often)
|
||||
|
|
@ -48,9 +68,12 @@ Any of the above reasons can lead to a Renovate branch being considered "stale"
|
|||
|
||||
#### Selective scheduling
|
||||
|
||||
Don't think that you need to apply blanket rules to scheduling. Remember that Renovate configuration is highly flexible so you can configure `automerge` anywhere from globally (entire repo) right down to a package/upgrade type level (e.g. you could even configure a nonsensical rule that patch updates of `jquery` are for Mondays only).
|
||||
Don't think that you need to apply blanket rules to scheduling.
|
||||
Remember that Renovate configuration is highly flexible so you can configure `automerge` anywhere from globally (entire repo) right down to a package/upgrade type level (e.g. you could even configure a nonsensical rule that patch updates of `jquery` are for Mondays only).
|
||||
|
||||
Remember earlier our example of grouping all `eslint`? If you think about it.. updates to `eslint` rules don't exactly need to be applied in real time! You don't want to get too far behind, so how about we update `eslint` packages only once a month?
|
||||
Remember earlier our example of grouping all `eslint`?
|
||||
If you think about it.. updates to `eslint` rules don't exactly need to be applied in real time!
|
||||
You don't want to get too far behind, so how about we update `eslint` packages only once a month?
|
||||
|
||||
```json
|
||||
"packageRules": [
|
||||
|
|
@ -74,21 +97,28 @@ Or perhaps at least weekly:
|
|||
]
|
||||
```
|
||||
|
||||
If you're wondering what is supported and not, under the hood, the schedule is parsed using [later.js](https://bunkat.github.io/later/) using the `later.parse.text(scheduleString)` API. [This page](https://bunkat.github.io/later/parsers.html#text) explains the supported syntax or you can experiment on the [RunKit playground](https://npm.runkit.com/later).
|
||||
If you're wondering what is supported and not, under the hood, the schedule is parsed using [later.js](https://bunkat.github.io/later/) using the `later.parse.text(scheduleString)` API.
|
||||
[This page](https://bunkat.github.io/later/parsers.html#text) explains the supported syntax or you can experiment on the [RunKit playground](https://npm.runkit.com/later).
|
||||
|
||||
## Automerging
|
||||
|
||||
Automerging is a Renovate feature that can save you a lot of time/noise directly, while also benefiting grouping and scheduling. In short: it means that Renovate can merge PRs or even branches itself if they pass your tests.
|
||||
Automerging is a Renovate feature that can save you a lot of time/noise directly, while also benefiting grouping and scheduling.
|
||||
In short: it means that Renovate can merge PRs or even branches itself if they pass your tests.
|
||||
|
||||
It is recommended that you enable automerge for any types of dependency updates where you would just click Merge anyway. We all know that there are some types of updates that we (nearly) always verify manually before merging, and plenty of others that we don't bother looking at unless tests fail. Every time you click Merge on a Renovate PR without manually testing it, you should consider if you can enable automerge and save yourself the time in future.
|
||||
It is recommended that you enable automerge for any types of dependency updates where you would just click Merge anyway.
|
||||
We all know that there are some types of updates that we (nearly) always verify manually before merging, and plenty of others that we don't bother looking at unless tests fail.
|
||||
Every time you click Merge on a Renovate PR without manually testing it, you should consider if you can enable automerge and save yourself the time in future.
|
||||
|
||||
Automerge works particularly well for `devDependencies` and for production `dependencies` that have great test coverage.
|
||||
|
||||
For example, if you have `jest` or `mocha` as a dependency, and it has an upgrade with passing tests.. automerge them! If you have a linter like `eslint` or `tslint` and its update passes.. automerge them! If you have an API with 100% test coverage and `express` is updated.. automerge it!
|
||||
For example, if you have `jest` or `mocha` as a dependency, and it has an upgrade with passing tests.. automerge them!
|
||||
If you have a linter like `eslint` or `tslint` and its update passes.. automerge them!
|
||||
If you have an API with 100% test coverage and `express` is updated.. automerge it!
|
||||
|
||||
#### Branch automerging
|
||||
|
||||
Those of you familiar with GitHub might note that even if you automerge PRs, you are still going to get notifications (noise) anyway - one when the PR is created and another when it is merged. For this reason we recommend you consider setting `automergeType=branch` which will mean:
|
||||
Those of you familiar with GitHub might note that even if you automerge PRs, you are still going to get notifications (noise) anyway - one when the PR is created and another when it is merged.
|
||||
For this reason we recommend you consider setting `automergeType=branch` which will mean:
|
||||
|
||||
- Renovate first creates a branch and no PR
|
||||
- If tests pass, Renovate pushes a commit directly to `master` without PR
|
||||
|
|
@ -98,7 +128,8 @@ The result is that passing updates are essentially "silent" - the only sign of t
|
|||
|
||||
#### Automerging and scheduling
|
||||
|
||||
Automerging is particularly beneficial if you have configured a schedule, because Renovate on its own may be able to automerge the majority of your updates. And this is especially so if your repository needs rebasing, e.g. because you use lock files. e.g. let's say you have dependencies `abc` and `xyz` with upgrades, and you use a `yarn.lock` file.
|
||||
Automerging is particularly beneficial if you have configured a schedule, because Renovate on its own may be able to automerge the majority of your updates.
|
||||
And this is especially so if your repository needs rebasing, e.g. because you use lock files. e.g. let's say you have dependencies `abc` and `xyz` with upgrades, and you use a `yarn.lock` file.
|
||||
|
||||
- At the start of the schedule, `Renovate` will create branches for `abc` and `xyz` upgrades, including `yarn.lock` updates
|
||||
- After `abc` passes tests, `Renovate` will automerge it to `master`
|
||||
|
|
@ -123,11 +154,13 @@ Remember our running `eslint` example? Let's automerge it if all the linting upd
|
|||
]
|
||||
```
|
||||
|
||||
Have you come up with a rule that you think others would benefit from? How about a PR back to [renovate-config](https://github.com/singapore/renovate-config) with the above rule named `":automergeEslintWeekly"` ?
|
||||
Have you come up with a rule that you think others would benefit from?
|
||||
How about a PR back to [renovate-config](https://github.com/singapore/renovate-config) with the above rule named `":automergeEslintWeekly"` ?
|
||||
|
||||
## Lock file considerations
|
||||
|
||||
Using lock files greatly increases the chance that merging one PR will result in a second PR becoming conflicted with `master`. The table below highlights different noise reduction strategies and their effect on pull request and potential lock file conflicts:
|
||||
Using lock files greatly increases the chance that merging one PR will result in a second PR becoming conflicted with `master`.
|
||||
The table below highlights different noise reduction strategies and their effect on pull request and potential lock file conflicts:
|
||||
|
||||
| Action | Effect on pull requests | Chance of lock file conflicts |
|
||||
| ------------------------------------ | ------------------------ | ----------------------------- |
|
||||
|
|
@ -137,9 +170,11 @@ Using lock files greatly increases the chance that merging one PR will result in
|
|||
|
||||
## The Future of Noise Reduction
|
||||
|
||||
First of all, if you ever have any ideas about how to make Renovate less noisy, please raise or comment on issues in the [main repository](https://github.com/renovatebot/renovate). Our philosophy is:
|
||||
First of all, if you ever have any ideas about how to make Renovate less noisy, please raise or comment on issues in the [main repository](https://github.com/renovatebot/renovate).
|
||||
Our philosophy is:
|
||||
|
||||
1. Nearly everyone should probably use Renovate-like dependency update automation
|
||||
2. Over time, you should "see" Renovate less and less
|
||||
|
||||
One of our hopes with preset configs is that a set of "sensible" configs can be maintained by the community that combine grouping, scheduling and automerging to reduce the amount of noise in repositories with little downside or increased risk. Such lists could be maintained and used somewhat like Adblock lists - kept up to date by maintainers but for the majority of users they are simply trusted/automatic/invisible.
|
||||
One of our hopes with preset configs is that a set of "sensible" configs can be maintained by the community that combine grouping, scheduling and automerging to reduce the amount of noise in repositories with little downside or increased risk.
|
||||
Such lists could be maintained and used somewhat like Adblock lists - kept up to date by maintainers but for the majority of users they are simply trusted/automatic/invisible.
|
||||
|
|
|
|||
|
|
@ -26,7 +26,8 @@ To convert your .NET Framework `.csproj`/`.fsproj`/`.vbproj` into an SDK-style p
|
|||
|
||||
## Alternate feeds
|
||||
|
||||
Renovate by default performs all lookups on `https://api.nuget.org/v3/index.json`, but it also supports alternative NuGet feeds. Alternative feeds can be specified either [in a `NuGet.config` file](https://docs.microsoft.com/en-us/nuget/reference/nuget-config-file#package-source-sections) within your repository (Renovate will not search outside the repository) or in Renovate configuration options:
|
||||
Renovate by default performs all lookups on `https://api.nuget.org/v3/index.json`, but it also supports alternative NuGet feeds.
|
||||
Alternative feeds can be specified either [in a `NuGet.config` file](https://docs.microsoft.com/en-us/nuget/reference/nuget-config-file#package-source-sections) within your repository (Renovate will not search outside the repository) or in Renovate configuration options:
|
||||
|
||||
```json
|
||||
"nuget": {
|
||||
|
|
@ -38,11 +39,15 @@ Renovate by default performs all lookups on `https://api.nuget.org/v3/index.json
|
|||
}
|
||||
```
|
||||
|
||||
If this example we defined 3 NuGet feeds. Packages resolving will process feeds consequentially. It means that if package will be resolved in second feed renovate won't look in last one.
|
||||
If this example we defined 3 NuGet feeds.
|
||||
Packages resolving will process feeds consequentially.
|
||||
It means that if package will be resolved in second feed renovate won't look in last one.
|
||||
|
||||
### Protocol versions
|
||||
|
||||
NuGet supports two protocol versions, `v2` and `v3`, which NuGet client and server need to agree on. Renovate as a NuGet client supports both versions and will use `v2` unless the configured feed URL ends with `index.json` (which mirrors the behavior of the official NuGet client). If you have `v3` feed that does not match this pattern (e.g. JFrog Artifactory) you need to help Renovate by appending `#protocolVersion=3` to the registry URL:
|
||||
NuGet supports two protocol versions, `v2` and `v3`, which NuGet client and server need to agree on.
|
||||
Renovate as a NuGet client supports both versions and will use `v2` unless the configured feed URL ends with `index.json` (which mirrors the behavior of the official NuGet client).
|
||||
If you have `v3` feed that does not match this pattern (e.g. JFrog Artifactory) you need to help Renovate by appending `#protocolVersion=3` to the registry URL:
|
||||
|
||||
```json
|
||||
"nuget": {
|
||||
|
|
|
|||
|
|
@ -36,9 +36,11 @@ If you are using a [privately hosted Composer package](https://getcomposer.org/d
|
|||
}
|
||||
```
|
||||
|
||||
This host rule is best added to the bot's `config.js` config so that it is not visible to users of the repository. If you are using the hosted WhiteSource Renovate App then you can encrypt it with Renovate's public key instead, so that only Renovate can decrypt it.
|
||||
This host rule is best added to the bot's `config.js` config so that it is not visible to users of the repository.
|
||||
If you are using the hosted WhiteSource Renovate App then you can encrypt it with Renovate's public key instead, so that only Renovate can decrypt it.
|
||||
|
||||
Go to [https://renovatebot.com/encrypt](https://renovatebot.com/encrypt), paste in the secret string you wish to encrypt, click _Encrypt_, then copy the encrypted result. You may encrypt your `password` only or even pass your `username` encrypted.
|
||||
Go to [https://renovatebot.com/encrypt](https://renovatebot.com/encrypt), paste in the secret string you wish to encrypt, click _Encrypt_, then copy the encrypted result.
|
||||
You may encrypt your `password` only or even pass your `username` encrypted.
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
|||
|
|
@ -11,7 +11,10 @@ Private npm modules are used at two times during Renovate's process.
|
|||
|
||||
#### 1. Module lookup
|
||||
|
||||
If a private npm module is listed as a dependency in a `package.json`, then Renovate will attempt to keep it up-to-date by querying the npm registry like it would for any other package. Hence, by default with no configuration a private package lookup will fail, because of lack of credentials. This means it won't be "renovated" and its version will remain unchanged in the package file unless you update it manually. These failures don't affect Renovate's ability to look up _other_ modules in the same package file.
|
||||
If a private npm module is listed as a dependency in a `package.json`, then Renovate will attempt to keep it up-to-date by querying the npm registry like it would for any other package.
|
||||
Hence, by default with no configuration a private package lookup will fail, because of lack of credentials.
|
||||
This means it won't be "renovated" and its version will remain unchanged in the package file unless you update it manually.
|
||||
These failures don't affect Renovate's ability to look up _other_ modules in the same package file.
|
||||
|
||||
Assuming the private module lookup succeeds (solutions for that are described later in this document) then private package versions will be kept up-to-date like public package versions are.
|
||||
|
||||
|
|
@ -19,7 +22,10 @@ Assuming the private module lookup succeeds (solutions for that are described la
|
|||
|
||||
If you are using a lock file (e.g. Yarn's `yarn.lock` or npm's `package-lock.json`) then Renovate needs to update that lock file whenever _any_ package listed in your package file is updated to a new version.
|
||||
|
||||
To do this, Renovate will run `npm install` or equivalent and save the resulting lock file. If a private module hasn't been updated, it _usually_ won't matter to npm/Yarn because they won't attempt to update its lock file entry anyway. However it's possible that the install will fail if it attempts to look up that private module for some reason, even when that private module is not the main one being updated. It's therefore better to provide Renovate with all the credentials it needs to look up private packages.
|
||||
To do this, Renovate will run `npm install` or equivalent and save the resulting lock file.
|
||||
If a private module hasn't been updated, it _usually_ won't matter to npm/Yarn because they won't attempt to update its lock file entry anyway.
|
||||
However it's possible that the install will fail if it attempts to look up that private module for some reason, even when that private module is not the main one being updated.
|
||||
It's therefore better to provide Renovate with all the credentials it needs to look up private packages.
|
||||
|
||||
## Supported npm authentication approaches
|
||||
|
||||
|
|
@ -35,13 +41,16 @@ All the various approaches are described below:
|
|||
|
||||
### Commit .npmrc file into repository
|
||||
|
||||
One approach that many projects use for private repositories is to simply check in an authenticated `.npmrc` into the repository that is then shared between all developers. Therefore anyone running `npm install` or `yarn install` from the project root will be automatically authenticated with npm without having to distribute npm logins to every developer and make sure they've run `npm login` first before installing.
|
||||
One approach that many projects use for private repositories is to simply check in an authenticated `.npmrc` into the repository that is then shared between all developers.
|
||||
Therefore anyone running `npm install` or `yarn install` from the project root will be automatically authenticated with npm without having to distribute npm logins to every developer and make sure they've run `npm login` first before installing.
|
||||
|
||||
The good news is that this works for Renovate too. If Renovate detects a `.npmrc` or `.yarnrc` file then it will use it for its install.
|
||||
The good news is that this works for Renovate too.
|
||||
If Renovate detects a `.npmrc` or `.yarnrc` file then it will use it for its install.
|
||||
|
||||
### Add npmrc string to Renovate config
|
||||
|
||||
The above solution maybe have a downside that all users of the repository (e.g. developers) will also use any `.npmrc` that is checked into the repository, instead of their own one in `~/.npmrc`. To avoid this, you can instead add your `.npmrc` authentication line to your Renovate config under the field `npmrc`. e.g. a `renovate.json` might look like this:
|
||||
The above solution maybe have a downside that all users of the repository (e.g. developers) will also use any `.npmrc` that is checked into the repository, instead of their own one in `~/.npmrc`.
|
||||
To avoid this, you can instead add your `.npmrc` authentication line to your Renovate config under the field `npmrc`. e.g. a `renovate.json` might look like this:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -77,7 +86,8 @@ Add the encrypted result inside an `encrypted` object like this:
|
|||
}
|
||||
```
|
||||
|
||||
If you have no `.npmrc` file then Renovate will create one for you, pointing to the default npmjs registry. If instead you use an alternative registry or need an `.npmrc` file for some other reason, you should configure it too and substitute the npm token with `${NPM_TOKEN}` for it to be replaced. e.g.
|
||||
If you have no `.npmrc` file then Renovate will create one for you, pointing to the default npmjs registry.
|
||||
If instead you use an alternative registry or need an `.npmrc` file for some other reason, you should configure it too and substitute the npm token with `${NPM_TOKEN}` for it to be replaced. e.g.
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -98,7 +108,8 @@ Renovate will then use the following logic:
|
|||
|
||||
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:
|
||||
You will then get an encrypted string that you can substitute into your renovate.json instead.
|
||||
The result will now look something like this:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
|||
|
|
@ -13,7 +13,8 @@ Renovate supports the following Python package managers:
|
|||
|
||||
## Versioning Support
|
||||
|
||||
The [PEP440](https://www.python.org/dev/peps/pep-0440/) versioning scheme has been rewritten for JavaScript for the purposes of use in this project is published as [@renovatebot/pep440](https://github.com/renovatebot/pep440). It supports both pinned versions as well as ranges. Legacy versions (`===` prefix) are ignored.
|
||||
The [PEP440](https://www.python.org/dev/peps/pep-0440/) versioning scheme has been rewritten for JavaScript for the purposes of use in this project is published as [@renovatebot/pep440](https://github.com/renovatebot/pep440).
|
||||
It supports both pinned versions as well as ranges. Legacy versions (`===` prefix) are ignored.
|
||||
|
||||
## How It Works
|
||||
|
||||
|
|
@ -24,7 +25,8 @@ The [PEP440](https://www.python.org/dev/peps/pep-0440/) versioning scheme has be
|
|||
|
||||
## Enabling Beta
|
||||
|
||||
Both `pipenv` and `setup.py` are classified a "beta", so they are not enabled by default. To enable them, you need to add configuration like the following to your `renovate.json` file:
|
||||
Both `pipenv` and `setup.py` are classified a "beta", so they are not enabled by default.
|
||||
To enable them, you need to add configuration like the following to your `renovate.json` file:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -34,11 +36,14 @@ Both `pipenv` and `setup.py` are classified a "beta", so they are not enabled by
|
|||
}
|
||||
```
|
||||
|
||||
Note: if you _only_ have these package files and no other package files (like `package.json`, `Dockerfile`, etc) then Renovate won't detect them and you won't get an onboarding PR. In that case you need to add Renovate configuration manually to skip the onboarding step.
|
||||
Note: if you _only_ have these package files and no other package files (like `package.json`, `Dockerfile`, etc) then Renovate won't detect them and you won't get an onboarding PR.
|
||||
In that case you need to add Renovate configuration manually to skip the onboarding step.
|
||||
|
||||
## Alternative file names
|
||||
|
||||
The default file matching regex for `requirements.txt` aims to pick up the most popular conventions for file naming, but it's possible that some get missed. If you have a specific file or file pattern you want to get found by Renovate, then you can do this by adding a new pattern under the `fileMatch` field of `pip_requirements`. e.g. you could add this to your config:
|
||||
The default file matching regex for `requirements.txt` aims to pick up the most popular conventions for file naming, but it's possible that some get missed.
|
||||
If you have a specific file or file pattern you want to get found by Renovate, then you can do this by adding a new pattern under the `fileMatch` field of `pip_requirements`.
|
||||
e.g. you could add this to your config:
|
||||
|
||||
```json
|
||||
"pip_requirements": {
|
||||
|
|
@ -48,11 +53,13 @@ The default file matching regex for `requirements.txt` aims to pick up the most
|
|||
|
||||
## Alternate registries
|
||||
|
||||
Renovate will default to performing all lookups on pypi.org, but it also supports alternative index URLs. There are two ways to achieve this:
|
||||
Renovate will default to performing all lookups on pypi.org, but it also supports alternative index URLs.
|
||||
There are two ways to achieve this:
|
||||
|
||||
#### index-url in `requirements.txt`
|
||||
|
||||
The index URL can be specified in the first line of the file, For example:
|
||||
The index URL can be specified in the first line of the file.
|
||||
For example:
|
||||
|
||||
```
|
||||
--index-url http://example.com/private-pypi/
|
||||
|
|
@ -66,7 +73,8 @@ Renovate will detect any custom-configured sources in `Pipfile` and use them.
|
|||
|
||||
#### Specify URL in configuration
|
||||
|
||||
The configuration option `registryUrls` can be used to configure an alternate index URL. Example:
|
||||
The configuration option `registryUrls` can be used to configure an alternate index URL.
|
||||
Example:
|
||||
|
||||
```json
|
||||
"python": {
|
||||
|
|
@ -74,7 +82,8 @@ The configuration option `registryUrls` can be used to configure an alternate in
|
|||
}
|
||||
```
|
||||
|
||||
Note: an index-url found in the `requirements.txt` will take precedent over a registryUrl configured like the above. To override the URL found in `requirements.txt`, you need to configure it in `packageRules`, as they are applied _after_ package file extraction.
|
||||
Note: an index-url found in the `requirements.txt` will take precedent over a registryUrl configured like the above.
|
||||
To override the URL found in `requirements.txt`, you need to configure it in `packageRules`, as they are applied _after_ package file extraction.
|
||||
|
||||
## Disabling Python Support
|
||||
|
||||
|
|
@ -86,7 +95,8 @@ The most direct way to disable all Python support in Renovate is like this:
|
|||
}
|
||||
```
|
||||
|
||||
Alternatively, maybe you only want one package manager, such as `npm`. In that case this would enable _only_ `npm`:
|
||||
Alternatively, maybe you only want one package manager, such as `npm`.
|
||||
In that case this would enable _only_ `npm`:
|
||||
|
||||
```json
|
||||
"enabledManagers": ["npm"]
|
||||
|
|
@ -94,4 +104,6 @@ Alternatively, maybe you only want one package manager, such as `npm`. In that c
|
|||
|
||||
## Future work
|
||||
|
||||
Feature requests are open for conda support and additional file types (e.g. `setup.cfg`). You can locate these issues by filtering on the [#python](https://github.com/renovatebot/renovate/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%23python) hashtag in the repository. Please +1 and/or add a comment to each issue that would benefit you so that we can gauge the popularity/importance of each.
|
||||
Feature requests are open for conda support and additional file types (e.g. `setup.cfg`).
|
||||
You can locate these issues by filtering on the [#python](https://github.com/renovatebot/renovate/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%23python) hashtag in the repository.
|
||||
Please +1 and/or add a comment to each issue that would benefit you so that we can gauge the popularity/importance of each.
|
||||
|
|
|
|||
|
|
@ -5,17 +5,22 @@ description: How to reconfigure Renovate once it's onboarded
|
|||
|
||||
# Reconfiguring Renovate
|
||||
|
||||
There will likely be times when you need to change your Renovate config. There are two recommended approaches:
|
||||
There will likely be times when you need to change your Renovate config.
|
||||
There are two recommended approaches:
|
||||
|
||||
## Reconfigure via PR
|
||||
|
||||
If you wish to make config edits directly, it's recommended to do so via a PR and then run Renovate's config validator to verify it. The validator is named `renovate-config-validator` and installed alongside `renovate` itself if you run `npm i -g renovate` or equivalent. If it validates your new config then it should be safe to merge.
|
||||
If you wish to make config edits directly, it's recommended to do so via a PR and then run Renovate's config validator to verify it.
|
||||
The validator is named `renovate-config-validator` and installed alongside `renovate` itself if you run `npm i -g renovate` or equivalent.
|
||||
If it validates your new config then it should be safe to merge.
|
||||
|
||||
## Nuke config and re-onboard
|
||||
|
||||
Perhaps you really liked the interactive PR and want to see it again. In that case:
|
||||
Perhaps you really liked the interactive PR and want to see it again.
|
||||
In that case:
|
||||
|
||||
1. Find and rename your original `Configure Renovate` PR (e.g. to `Configure Renovate - old`)
|
||||
2. Delete your Renovate config (e.g. `renovate.json`) from your base branch
|
||||
|
||||
This will be enough to trick Renovate into thinking that the repository was _never_ onboarded and it will trigger a new Configure Renovate PR again. Any existing Renovate PRs in progress may be closed, however.
|
||||
This will be enough to trick Renovate into thinking that the repository was _never_ onboarded and it will trigger a new Configure Renovate PR again.
|
||||
Any existing Renovate PRs in progress may be closed, however.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ description: Ruby Bundler support in Renovate
|
|||
|
||||
# Automated Dependency Updates for Ruby Bundler Dependencies
|
||||
|
||||
Renovate supports upgrading dependencies in Bundler's `Gemfile`s and their accompanying `Gemfile.lock` files. Support is considered "alpha" stage until there have been some more real-world tests.
|
||||
Renovate supports upgrading dependencies in Bundler's `Gemfile`s and their accompanying `Gemfile.lock` files.
|
||||
Support is considered "alpha" stage until there have been some more real-world tests.
|
||||
|
||||
## How It Works
|
||||
|
||||
|
|
@ -17,7 +18,8 @@ Renovate supports upgrading dependencies in Bundler's `Gemfile`s and their accom
|
|||
|
||||
## Enabling
|
||||
|
||||
Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) for self-hosted. Bundler support is now enabled by default in both.
|
||||
Either install the [Renovate App](https://github.com/apps/renovate) on GitHub, or check out [Renovate OSS](https://github.com/renovatebot/renovate) for self-hosted.
|
||||
Bundler support is now enabled by default in both.
|
||||
|
||||
## Future work
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,8 @@ The below configuration options are applicable only if you are running your own
|
|||
|
||||
## allowedPostUpgradeCommands
|
||||
|
||||
A list of regular expressions that determine which commands in `postUpgradeTasks` are allowed to be executed. If this list is empty then no tasks will be executed.
|
||||
A list of regular expressions that determine which commands in `postUpgradeTasks` are allowed to be executed.
|
||||
If this list is empty then no tasks will be executed.
|
||||
|
||||
e.g.
|
||||
|
||||
|
|
@ -21,7 +22,8 @@ e.g.
|
|||
|
||||
## autodiscover
|
||||
|
||||
Be cautious when using this option - it will run Renovate over _every_ repository that the bot account has access to. To filter this list, use `autodiscoverFilter`.
|
||||
Be cautious when using this option - it will run Renovate over _every_ repository that the bot account has access to.
|
||||
To filter this list, use `autodiscoverFilter`.
|
||||
|
||||
## autodiscoverFilter
|
||||
|
||||
|
|
@ -29,7 +31,8 @@ A [minimatch](https://www.npmjs.com/package/minimatch) glob-style pattern for fi
|
|||
|
||||
## baseDir
|
||||
|
||||
Configure this directory if you want to change which directory Renovate uses for storing data. If left unconfigured, it will typically be a temporary directory like `/tmp/renovate/`.
|
||||
Configure this directory if you want to change which directory Renovate uses for storing data.
|
||||
If left unconfigured, it will typically be a temporary directory like `/tmp/renovate/`.
|
||||
|
||||
## binarySource
|
||||
|
||||
|
|
@ -38,7 +41,9 @@ Set this to `docker` instead to use Docker-based binaries.
|
|||
|
||||
## cacheDir
|
||||
|
||||
Configure this directory if you want to change which directory Renovate uses for storing cache data. If left unconfigured, it will typically be a temporary directory like `/tmp/renovate/cache/`. If you configure this to be different to the `baseDir`, it means you can have one location for repo data and another for cache data.
|
||||
Configure this directory if you want to change which directory Renovate uses for storing cache data.
|
||||
If left unconfigured, it will typically be a temporary directory like `/tmp/renovate/cache/`.
|
||||
If you configure this to be different to the `baseDir`, it means you can have one location for repo data and another for cache data.
|
||||
|
||||
## composerIgnorePlatformReqs
|
||||
|
||||
|
|
@ -52,11 +57,14 @@ If this is set to `ghcr.io/renovatebot` the final image for `node` would become
|
|||
|
||||
## dockerMapDotfiles
|
||||
|
||||
This is used if you want to map "dotfiles" from your host computer home directory to containers that Renovate creates, e.g. for updating lock files. Currently applicable to `.npmrc` only.
|
||||
This is used if you want to map "dotfiles" from your host computer home directory to containers that Renovate creates, e.g. for updating lock files.
|
||||
Currently applicable to `.npmrc` only.
|
||||
|
||||
## dockerUser
|
||||
|
||||
Override default user and group used by Docker-based binaries. UID and GID should match the user that executes renovate. See [Docker run reference](https://docs.docker.com/engine/reference/run/#user) for more information on user and group syntax.
|
||||
Override default user and group used by Docker-based binaries.
|
||||
UID and GID should match the user that executes renovate.
|
||||
See [Docker run reference](https://docs.docker.com/engine/reference/run/#user) for more information on user and group syntax.
|
||||
Set this to `1001:1002` to use UID 1001 and GID 1002.
|
||||
|
||||
## dryRun
|
||||
|
|
@ -65,13 +73,15 @@ Set this to `1001:1002` to use UID 1001 and GID 1002.
|
|||
|
||||
## force
|
||||
|
||||
This object is used as a "force override" when you need to make sure certain configuration overrides whatever is configured in the repository. For example, forcing a null (no) schedule to make sure Renovate raises PRs on a run even if the repository itself or its preset defines a schedule that's currently in active.
|
||||
This object is used as a "force override" when you need to make sure certain configuration overrides whatever is configured in the repository.
|
||||
For example, forcing a null (no) schedule to make sure Renovate raises PRs on a run even if the repository itself or its preset defines a schedule that's currently in active.
|
||||
|
||||
In practice, it is implemented by converting the `force` configuration into a `packageRule` that matches all packages.
|
||||
|
||||
## forceCli
|
||||
|
||||
This is set to true by default, meaning that any settings (such as `schedule`) take maximum priority even against custom settings existing inside individual repositories. It will also override any settings in `packageRules`.
|
||||
This is set to true by default, meaning that any settings (such as `schedule`) take maximum priority even against custom settings existing inside individual repositories.
|
||||
It will also override any settings in `packageRules`.
|
||||
|
||||
## forkMode
|
||||
|
||||
|
|
@ -79,15 +89,20 @@ You probably have no need for this option - it is an experimental setting for th
|
|||
|
||||
## gitAuthor
|
||||
|
||||
RFC5322-compliant string if you wish to customise the Git author for commits. If you need to transition from one Git author to another, put the old gitAuthor into `RENOVATE_LEGACY_GIT_AUTHOR_EMAIL` in environment. Renovate will then check against it as well as the current Git author value before deciding if a branch has been modified.
|
||||
RFC5322-compliant string if you wish to customise the Git author for commits.
|
||||
If you need to transition from one Git author to another, put the old gitAuthor into `RENOVATE_LEGACY_GIT_AUTHOR_EMAIL` in environment.
|
||||
Renovate will then check against it as well as the current Git author value before deciding if a branch has been modified.
|
||||
|
||||
**Note** It is strongly recommended that the Git author email you provide should be unique to Renovate. Otherwise, if another bot or human shares the same email and pushes to one of Renovate's branches then Renovate will mistake the branch as unmodified and potentially force push over the changes.
|
||||
**Note** It is strongly recommended that the Git author email you provide should be unique to Renovate.
|
||||
Otherwise, if another bot or human shares the same email and pushes to one of Renovate's branches then Renovate will mistake the branch as unmodified and potentially force push over the changes.
|
||||
|
||||
## gitPrivateKey
|
||||
|
||||
This should be an armored private key, e.g. the type you get from running `gpg --export-secret-keys --armor 92066A17F0D1707B4E96863955FEF5171C45FAE5 > private.key`. Replace the newlines with `\n` before adding the resulting single-line value to your bot's config.
|
||||
This should be an armored private key, e.g. the type you get from running `gpg --export-secret-keys --armor 92066A17F0D1707B4E96863955FEF5171C45FAE5 > private.key`.
|
||||
Replace the newlines with `\n` before adding the resulting single-line value to your bot's config.
|
||||
|
||||
It will be loaded _lazily_. Before the first commit in a repository, Renovate will:
|
||||
It will be loaded _lazily_.
|
||||
Before the first commit in a repository, Renovate will:
|
||||
|
||||
- First, run `gpg import` if it hasn't been run before
|
||||
- Then, run `git config user.signingkey` and `git config commit.gpgsign true`
|
||||
|
|
@ -96,7 +111,8 @@ The `git` commands are run locally in the cloned repo instead of globally to red
|
|||
|
||||
## logContext
|
||||
|
||||
`logContext` is included with each log entry only if `logFormat="json"` - it is not included in the pretty log output. If left as default (null), a random short ID will be selected.
|
||||
`logContext` is included with each log entry only if `logFormat="json"` - it is not included in the pretty log output.
|
||||
If left as default (null), a random short ID will be selected.
|
||||
|
||||
## logFile
|
||||
|
||||
|
|
@ -104,7 +120,8 @@ The `git` commands are run locally in the cloned repo instead of globally to red
|
|||
|
||||
## logLevel
|
||||
|
||||
It's recommended to run at debug level if you can, and configure it using the environment variable `LOG_LEVEL=debug`. By configuring using the environment it means that debug logging starts from the beginning of the app, while if you configure it using file config then the debug logging can only start after the file config is parsed.
|
||||
It's recommended to run at debug level if you can, and configure it using the environment variable `LOG_LEVEL=debug`.
|
||||
By configuring using the environment it means that debug logging starts from the beginning of the app, while if you configure it using file config then the debug logging can only start after the file config is parsed.
|
||||
|
||||
Additionally, if you configure `LOG_FORMAT=json` in env then logging will be done in JSON format instead of "pretty" format, which is usually better if you're doing any ingestion or parsing of the logs.
|
||||
|
||||
|
|
@ -114,7 +131,9 @@ Set this to `false` if (a) you configure Renovate entirely on the bot side (i.e.
|
|||
|
||||
## onboardingBranch
|
||||
|
||||
Note that this setting is independent of `branchPrefix`. For example, if you configure `branchPrefix` to be `renovate-` then you'd still have the onboarding PR created with branch `renovate/configure` until you configure `onboardingBranch=renovate-configure` or similar. If you have an existing Renovate installation and you change `onboardingBranch` then it's possible that you'll get onboarding PRs for repositories that had previously closed the onboarding PR unmerged.
|
||||
Note that this setting is independent of `branchPrefix`.
|
||||
For example, if you configure `branchPrefix` to be `renovate-` then you'd still have the onboarding PR created with branch `renovate/configure` until you configure `onboardingBranch=renovate-configure` or similar.
|
||||
If you have an existing Renovate installation and you change `onboardingBranch` then it's possible that you'll get onboarding PRs for repositories that had previously closed the onboarding PR unmerged.
|
||||
|
||||
## onboardingCommitMessage
|
||||
|
||||
|
|
@ -132,23 +151,30 @@ Similarly to `onboardingBranch`, if you have an existing Renovate installation a
|
|||
|
||||
## persistRepoData
|
||||
|
||||
Set this to true if you wish for Renovate to persist repo data between runs. The intention is that this allows Renovate to do a faster `git fetch` between runs rather than `git clone`. It also may mean that ignored directories like `node_modules` can be preserved and save time on operations like `npm install`.
|
||||
Set this to true if you wish for Renovate to persist repo data between runs.
|
||||
The intention is that this allows Renovate to do a faster `git fetch` between runs rather than `git clone`.
|
||||
It also may mean that ignored directories like `node_modules` can be preserved and save time on operations like `npm install`.
|
||||
|
||||
## platform
|
||||
|
||||
## prCommitsPerRunLimit
|
||||
|
||||
Parameter to reduce CI load. CI jobs are usually triggered by these events: pull-request creation, pull-request update, automerge events. Set as an integer. Default is no limit.
|
||||
Parameter to reduce CI load.
|
||||
CI jobs are usually triggered by these events: pull-request creation, pull-request update, automerge events.
|
||||
Set as an integer.
|
||||
Default is no limit.
|
||||
|
||||
## printConfig
|
||||
|
||||
This option is useful for troubleshooting, particularly if using presets. e.g. run `renovate foo/bar --print-config > config.log` and the fully-resolved config will be included in the log file.
|
||||
This option is useful for troubleshooting, particularly if using presets.
|
||||
e.g. run `renovate foo/bar --print-config > config.log` and the fully-resolved config will be included in the log file.
|
||||
|
||||
## privateKey
|
||||
|
||||
This private key is used to decrypt config files.
|
||||
|
||||
The corresponding public key can be used to create encrypted values for config files. If you want a simple UI to encrypt values you can put the public key in a HTML page similar to <https://renovatebot.com/encrypt>.
|
||||
The corresponding public key can be used to create encrypted values for config files.
|
||||
If you want a simple UI to encrypt values you can put the public key in a HTML page similar to <https://renovatebot.com/encrypt>.
|
||||
|
||||
To create the key pair with openssl use the following commands:
|
||||
|
||||
|
|
@ -165,13 +191,17 @@ Override this object if you wish to change the URLs that Renovate links to, e.g.
|
|||
|
||||
## redisUrl
|
||||
|
||||
If this value is set then Renovate will use Redis for its global cache instead of the local file system. The global cache is used to store lookup results (e.g. dependency versions and release notes) between repositories and runs. Example url: `redis://localhost`.
|
||||
If this value is set then Renovate will use Redis for its global cache instead of the local file system.
|
||||
The global cache is used to store lookup results (e.g. dependency versions and release notes) between repositories and runs.
|
||||
Example url: `redis://localhost`.
|
||||
|
||||
## repositories
|
||||
|
||||
## repositoryCache
|
||||
|
||||
Set this to `"enabled"` to have Renovate maintain a JSON file cache per-repository to speed up extractions. Set to `"reset"` if you ever need to bypass the cache and have it overwritten. JSON files will be stored inside the `cacheDir` beside the existing file-based package cache.
|
||||
Set this to `"enabled"` to have Renovate maintain a JSON file cache per-repository to speed up extractions.
|
||||
Set to `"reset"` if you ever need to bypass the cache and have it overwritten.
|
||||
JSON files will be stored inside the `cacheDir` beside the existing file-based package cache.
|
||||
|
||||
Warning: this is an experimental feature and may be modified or removed in a future non-major release.
|
||||
|
||||
|
|
@ -179,7 +209,9 @@ Warning: this is an experimental feature and may be modified or removed in a fut
|
|||
|
||||
## skipInstalls
|
||||
|
||||
By default, Renovate will use the most efficient approach to updating package files and lock files, which in most cases skips the need to perform a full module install by the bot. If this is set to false, then a full install of modules will be done. This is currently applicable to `npm` and `lerna`/`npm` only, and only used in cases where bugs in `npm` result in incorrect lock files being updated.
|
||||
By default, Renovate will use the most efficient approach to updating package files and lock files, which in most cases skips the need to perform a full module install by the bot.
|
||||
If this is set to false, then a full install of modules will be done.
|
||||
This is currently applicable to `npm` and `lerna`/`npm` only, and only used in cases where bugs in `npm` result in incorrect lock files being updated.
|
||||
|
||||
## token
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,9 @@ The same goes for any other third party binary tool that may be needed, such as
|
|||
|
||||
#### Docker
|
||||
|
||||
Renovate is available for Docker via an automated build [renovate/renovate](https://hub.docker.com/r/renovate/renovate/). It builds `latest` based on the `master` branch and all semver tags are published too. All the following are valid:
|
||||
Renovate is available for Docker via an automated build [renovate/renovate](https://hub.docker.com/r/renovate/renovate/).
|
||||
It builds `latest` based on the `master` branch and all semver tags are published too.
|
||||
All the following are valid:
|
||||
|
||||
```sh
|
||||
$ docker run --rm renovate/renovate
|
||||
|
|
@ -29,7 +31,8 @@ $ docker run --rm renovate/renovate:19
|
|||
|
||||
(Please look up what the latest actual tags are though, do not use the above literally).
|
||||
|
||||
If you wish to configure Renovate using a `config.js` file then map it to `/usr/src/app/config.js` using Docker volumes. For example:
|
||||
If you wish to configure Renovate using a `config.js` file then map it to `/usr/src/app/config.js` using Docker volumes.
|
||||
For example:
|
||||
|
||||
```sh
|
||||
$ docker run --rm -v "/path/to/your/config.js:/usr/src/app/config.js" renovate/renovate
|
||||
|
|
@ -37,7 +40,9 @@ $ docker run --rm -v "/path/to/your/config.js:/usr/src/app/config.js" renovate/r
|
|||
|
||||
#### Kubernetes
|
||||
|
||||
Renovate's official Docker image is compatible with Kubernetes. The following is an example manifest of running Renovate against a GitHub Enterprise server. First the Kubernetes manifest:
|
||||
Renovate's official Docker image is compatible with Kubernetes.
|
||||
The following is an example manifest of running Renovate against a GitHub Enterprise server.
|
||||
First the Kubernetes manifest:
|
||||
|
||||
```yaml
|
||||
apiVersion: batch/v1beta1
|
||||
|
|
@ -147,11 +152,13 @@ Self-hosted Renovate can be configured using any of the following (or a combinat
|
|||
- CLI params
|
||||
- Environment params
|
||||
|
||||
Note that some Renovate configuration options are _only_ available for self-hosting, and so can only be configured using one of the above methods. These are described in the [Self-hosted Configuration](./self-hosted-configuration.md) doc.
|
||||
Note that some Renovate configuration options are _only_ available for self-hosting, and so can only be configured using one of the above methods.
|
||||
These are described in the [Self-hosted Configuration](./self-hosted-configuration.md) doc.
|
||||
|
||||
## Authentication
|
||||
|
||||
Regardless of platform, you need to select a user account for `renovate` to assume the identity of, and generate a Personal Access Token. It is recommended to be `@renovate-bot` if you are using a self-hosted server with free choice of usernames.
|
||||
Regardless of platform, you need to select a user account for `renovate` to assume the identity of, and generate a Personal Access Token.
|
||||
It is recommended to be `@renovate-bot` if you are using a self-hosted server with free choice of usernames.
|
||||
It is also recommended that you configure `config.gitAuthor` with the same identity as your Renovate user, e.g. like `"gitAuthor": "Renovate Bot <renovate@whitesourcesoftware.com>"`.
|
||||
|
||||
#### GitHub Enterprise
|
||||
|
|
@ -193,7 +200,10 @@ Don't forget to configure `platform=gitea` somewhere in config.
|
|||
|
||||
## GitHub.com token for release notes
|
||||
|
||||
If you are running on any platform except github.com, it's important to also configure the environment variable `GITHUB_COM_TOKEN` containing a personal access token for github.com. This account can actually be _any_ account on GitHub, and needs only read-only access. 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.
|
||||
If you are running on any platform except github.com, it's important to also configure the environment variable `GITHUB_COM_TOKEN` containing a personal access token for github.com.
|
||||
This account can actually be _any_ account on GitHub, and needs only read-only access.
|
||||
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 m=Modules hosted on GitHub) it is highly recommended to add a token as you will run in 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.
|
||||
|
||||
|
|
@ -213,7 +223,9 @@ If you wish to override the cache location specifically then configure a value f
|
|||
|
||||
The following example uses the Renovate CLI tool, which can be installed by running `npm i -g renovate`.
|
||||
|
||||
If running your own Renovate bot then you will need a user account that Renovate will run as. It's recommended to use a dedicated account for the bot, e.g. name it `renovate-bot` if on your own instance. Create and save a Personal Access Token for this account.
|
||||
If running your own Renovate bot then you will need a user account that Renovate will run as.
|
||||
It's recommended to use a dedicated account for the bot, e.g. name it `renovate-bot` if on your own instance.
|
||||
Create and save a Personal Access Token for this account.
|
||||
|
||||
Create a Renovate config file, e.g. here is an example:
|
||||
|
||||
|
|
@ -230,7 +242,8 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
Here change the `logFile` and `repositories` to something appropriate. Also replace `gitlab-token` value with the one created during the previous step.
|
||||
Here change the `logFile` and `repositories` to something appropriate.
|
||||
Also replace `gitlab-token` value with the one created during the previous step.
|
||||
|
||||
If running against GitHub Enterprise, change the above `gitlab` values to the equivalent GitHub ones.
|
||||
|
||||
|
|
@ -250,7 +263,8 @@ export GITHUB_COM_TOKEN="**github-token**" # Delete this if using github.com
|
|||
renovate
|
||||
```
|
||||
|
||||
Note: the GitHub.com token in env is necessary in order to retrieve Release Notes that are usually hosted on github.com. You don't need to add it if you are already running the bot against github.com, but you do need to add it if you're using GitHub Enterprise, GitLab, Azure DevOps, or Bitbucket.
|
||||
Note: the GitHub.com token in env is necessary in order to retrieve Release Notes that are usually hosted on github.com.
|
||||
You don't need to add it if you are already running the bot against github.com, but you do need to add it if you're using GitHub Enterprise, GitLab, Azure DevOps, or Bitbucket.
|
||||
|
||||
You should save and test out this script manually first, and add it to cron once you've verified it.
|
||||
|
||||
|
|
@ -290,8 +304,8 @@ metadata:
|
|||
namespace: <namespace>
|
||||
```
|
||||
|
||||
Then you just need to add Git author, and mount volumes
|
||||
The final configuration should look like something like this :
|
||||
Then you just need to add Git author, and mount volumes.
|
||||
The final configuration should look like something like this:
|
||||
|
||||
```yml
|
||||
---
|
||||
|
|
@ -360,4 +374,5 @@ spec:
|
|||
|
||||
## Logging
|
||||
|
||||
It's recommended to configure `LOG_LEVEL=debug` and `LOG_FORMAT=json` in environment if you are ingesting/parsing logs into another system. Debug logging is usually necessary for any debugging, while JSON format will mean that the output is parseable.
|
||||
It's recommended to configure `LOG_LEVEL=debug` and `LOG_FORMAT=json` in environment if you are ingesting/parsing logs into another system.
|
||||
Debug logging is usually necessary for any debugging, while JSON format will mean that the output is parseable.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ description: Configuring Renovate to use Semantic Commits
|
|||
|
||||
# Semantic Commit Messages
|
||||
|
||||
Renovate attempts to autodetect if your repository uses "semantic" commit message prefixes, and adds them if so. To do so, it looks at the 10 most recent commit messages in the base branch and uses [conventional-commits-detector](https://github.com/conventional-changelog/conventional-commits-detector) to determine convention commit type.
|
||||
Renovate attempts to autodetect if your repository uses "semantic" commit message prefixes, and adds them if so.
|
||||
To do so, it looks at the 10 most recent commit messages in the base branch and uses [conventional-commits-detector](https://github.com/conventional-changelog/conventional-commits-detector) to determine convention commit type.
|
||||
|
||||
Currently, Renovate ignores commit conventions apart from "angular".
|
||||
|
||||
|
|
@ -22,10 +23,13 @@ If you wish to manually override Renovate's semantic commit detection, then you
|
|||
|
||||
## Changing the Semantic Commit Type
|
||||
|
||||
If you wish to say use "chore" for every PR, then you can add `":semanticCommitTypeAll(chore)"` to your `extends` array. Or if you wish to use `ci` then you would add `":semanticCommitTypeAll(ci)"` instead. This second case would mean your PR titles and commit messages will start with "ci(deps):".
|
||||
If you wish to say use "chore" for every PR, then you can add `":semanticCommitTypeAll(chore)"` to your `extends` array.
|
||||
Or if you wish to use `ci` then you would add `":semanticCommitTypeAll(ci)"` instead.
|
||||
This second case would mean your PR titles and commit messages will start with "ci(deps):".
|
||||
|
||||
## Changing the Semantic Commit Scope
|
||||
|
||||
If you don't like "deps" then this can also be configured. For example, to set it to "package" you should add the preset `":semanticCommitScope(package)"` to your `extends` array.
|
||||
If you don't like "deps" then this can also be configured.
|
||||
For example, to set it to "package" you should add the preset `":semanticCommitScope(package)"` to your `extends` array.
|
||||
|
||||
If you wish to _remove_ the semantic commit scope (e.g. use prefix `chore:` instead of `chore(deps):`) then you should add the preset `":semanticCommitScopeDisabled"` to your `extends` array.
|
||||
|
|
|
|||
|
|
@ -78,4 +78,5 @@ jobs:
|
|||
npx --userconfig .npmrc renovate
|
||||
```
|
||||
|
||||
1. Additionally, you can add `renovate.json` with renovate configurations in the root of the repo. [Read more about configurations options](https://docs.renovatebot.com/configuration-options/).
|
||||
1. Additionally, you can add `renovate.json` with renovate configurations in the root of the repo.
|
||||
[Read more about configurations options](https://docs.renovatebot.com/configuration-options/).
|
||||
|
|
|
|||
|
|
@ -7,9 +7,11 @@ description:
|
|||
|
||||
In order to provide flexible configuration, Renovate supports using "templates" for certain fields like `branchName`.
|
||||
|
||||
Renovate's templates use [handlebars](https://handlebarsjs.com/) under the hood. You can recognize templates when you see strings like `{{depName}}` in configuration fields.
|
||||
Renovate's templates use [handlebars](https://handlebarsjs.com/) under the hood.
|
||||
You can recognize templates when you see strings like `{{depName}}` in configuration fields.
|
||||
|
||||
Below you can find lists of fields/values that you can use in templates. Some are configuration options passed through, while others are generated as part of Renovate's run.
|
||||
Below you can find lists of fields/values that you can use in templates.
|
||||
Some are configuration options passed through, while others are generated as part of Renovate's run.
|
||||
|
||||
## Exposed Config Options
|
||||
|
||||
|
|
|
|||
|
|
@ -7,15 +7,21 @@ description: How Renovate Updates and Rebases Branches
|
|||
|
||||
There are many cases where Renovate will need to update a branch/PR after its initial creation, and this document will attempt to describe them.
|
||||
|
||||
Note: Renovate doesn't technically do "rebasing" in the Git sense. Instead, it manually recreates the same commit based off of the latest commit in base branch.
|
||||
Note: Renovate doesn't technically do "rebasing" in the Git sense.
|
||||
Instead, it manually recreates the same commit based off of the latest commit in base branch.
|
||||
|
||||
## If you have made edits
|
||||
|
||||
First of all, here is the one time when Renovate _won't_ update branches. If you have edited a Renovate branch directly (e.g. to make a code fix to allow tests to pass again) then Renovate will stop all updates of that branch. It is up to you to either finish the job and merge the PR, or rename it and close it so that Renovate can take back over again.
|
||||
First of all, here is the one time when Renovate _won't_ update branches.
|
||||
If you have edited a Renovate branch directly (e.g. to make a code fix to allow tests to pass again) then Renovate will stop all updates of that branch.
|
||||
It is up to you to either finish the job and merge the PR, or rename it and close it so that Renovate can take back over again.
|
||||
|
||||
## Rebasing Conflicted PRs
|
||||
|
||||
If new commits to the base branch - such as merging another Renovate PR - result in an open Renovate PR having merge conflicts, then Renovate will recreate ("rebase") any conflicted PRs. This applies both to commits to dependency files such as `package.json` as well as lock files such as `yarn.lock`. You should not ever need to resolve such conflicts manually. You can disable this functionality by configuring `"rebaseWhen": "never"` (not recommended);
|
||||
If new commits to the base branch - such as merging another Renovate PR - result in an open Renovate PR having merge conflicts, then Renovate will recreate ("rebase") any conflicted PRs.
|
||||
This applies both to commits to dependency files such as `package.json` as well as lock files such as `yarn.lock`.
|
||||
You should not ever need to resolve such conflicts manually.
|
||||
You can disable this functionality by configuring `"rebaseWhen": "never"` (not recommended);
|
||||
|
||||
## Rebasing Out-of-date Branches
|
||||
|
||||
|
|
@ -28,16 +34,19 @@ In that case Renovate PRs will be continuously rebased off the repository's base
|
|||
|
||||
## Newer Dependency Versions
|
||||
|
||||
If an existing PR is open to upgrade dependency "foo" to v1.1.0 and then v1.1.1 is released, then Renovate will regenerate the branch again. This way:
|
||||
If an existing PR is open to upgrade dependency "foo" to v1.1.0 and then v1.1.1 is released, then Renovate will regenerate the branch again.
|
||||
This way:
|
||||
|
||||
- Each Renovate branch will always have 1 and only 1 commit
|
||||
- The newest version will be based off the latest base branch commit at the time
|
||||
|
||||
## Manual rebasing
|
||||
|
||||
It is possible to manually request that Renovate rebase a PR by ticking a rebase/retry checkbox on GitHub or GitLab, or by adding the label "rebase" to a Renovate PR. This label name is also configurable via the `rebaseLabel` config option too.
|
||||
It is possible to manually request that Renovate rebase a PR by ticking a rebase/retry checkbox on GitHub or GitLab, or by adding the label "rebase" to a Renovate PR.
|
||||
This label name is also configurable via the `rebaseLabel` config option too.
|
||||
|
||||
If you apply this label then Renovate will regenerate its commit for the branch, even if the branch has been modified. Therefore it is useful in situations such as:
|
||||
If you apply this label then Renovate will regenerate its commit for the branch, even if the branch has been modified.
|
||||
Therefore it is useful in situations such as:
|
||||
|
||||
- If a branch is stale but you don't have `rebaseWhen=behind-base-branch` enabled
|
||||
- If a branch has been edited and you wish to discard the edits and have Renovate create it again
|
||||
|
|
|
|||
22
readme.md
22
readme.md
|
|
@ -36,14 +36,23 @@ Renovate was released in 2017 and already is widely used in the developer commun
|
|||
|
||||
## Using Renovate
|
||||
|
||||
The easiest way to use Renovate if you are hosted on GitHub.com or GitLab.com is to install the hosted Renovate app. On Azure DevOps you can install Renovate as an extension from the marketplace.
|
||||
The easiest way to use Renovate if you are hosted on GitHub.com or GitLab.com is to install the hosted Renovate app.
|
||||
On Azure DevOps you can install Renovate as an extension from the marketplace.
|
||||
|
||||
For GitHub, go to [https://github.com/apps/renovate](https://github.com/apps/renovate) to install
|
||||
it now. A GitHub Marketplace plan is required only for private repositories. [More details on the GitHub App installation](https://docs.renovatebot.com/install-github-app/).
|
||||
For GitHub, go to [https://github.com/apps/renovate](https://github.com/apps/renovate) to install it now.
|
||||
A GitHub Marketplace plan is required only for private repositories.
|
||||
[More details on the GitHub App installation](https://docs.renovatebot.com/install-github-app/).
|
||||
|
||||
For GitLab, log into [app.renovatebot.com/dashboard](https://app.renovatebot.com/dashboard) for a convenient way to add Renovate Bot to your project. Currently the GitLab app is free for both public and private repositories. [More details on the GitLab App installation](https://docs.renovatebot.com/install-gitlab-app/).
|
||||
For GitLab, log into [app.renovatebot.com/dashboard](https://app.renovatebot.com/dashboard) for a convenient way to add Renovate Bot to your project.
|
||||
Currently the GitLab app is free for both public and private repositories.
|
||||
[More details on the GitLab App installation](https://docs.renovatebot.com/install-gitlab-app/).
|
||||
|
||||
For Azure DevOps, visit the Visual Studio Marketplace and install the [Renovate Me](https://marketplace.visualstudio.com/items?itemName=jyc.vsts-extensions-renovate-me) extension in your organisation. From there you can create a pipeline with the `RenovateMe` task. [More details on how to configure the pipeline](https://marketplace.visualstudio.com/items?itemName=jyc.vsts-extensions-renovate-me). Note: This extension is created and maintained personally by a Renovate developer/user so support requests relating to the extension itself cannot be answered directly in the main Renovate repository. Alternatively, you can create custom pipeline with with a `yml` definition that will trigger `npx renovate`. [More details on how to configure the pipeline](https://docs.renovatebot.com/setup-azure-devops/).
|
||||
For Azure DevOps, visit the Visual Studio Marketplace and install the [Renovate Me](https://marketplace.visualstudio.com/items?itemName=jyc.vsts-extensions-renovate-me) extension in your organisation.
|
||||
From there you can create a pipeline with the `RenovateMe` task.
|
||||
[More details on how to configure the pipeline](https://marketplace.visualstudio.com/items?itemName=jyc.vsts-extensions-renovate-me).
|
||||
Note: This extension is created and maintained personally by a Renovate developer/user so support requests relating to the extension itself cannot be answered directly in the main Renovate repository.
|
||||
Alternatively, you can create custom pipeline with with a `yml` definition that will trigger `npx renovate`.
|
||||
[More details on how to configure the pipeline](https://docs.renovatebot.com/setup-azure-devops/).
|
||||
|
||||
## Configuration
|
||||
|
||||
|
|
@ -67,4 +76,5 @@ If you would like to contribute to Renovate or get a local copy running for some
|
|||
|
||||
## Security / Disclosure
|
||||
|
||||
If you discover any important bug with Renovate that may pose a security problem, please disclose it confidentially to renovate-disclosure@whitesourcesoftware.com first, so that it can be assessed and hopefully fixed prior to being exploited. Please do not raise GitHub issues for security-related doubts or problems.
|
||||
If you discover any important bug with Renovate that may pose a security problem, please disclose it confidentially to renovate-disclosure@whitesourcesoftware.com first, so that it can be assessed and hopefully fixed prior to being exploited.
|
||||
Please do not raise GitHub issues for security-related doubts or problems.
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче