2018-06-26 09:31:18 +00:00
2017-07-17 15:05:20 +00:00
2017-12-27 12:15:55 +00:00
# Renovate
2016-12-17 16:26:06 +00:00
2018-01-22 13:28:58 +00:00
Automated dependency updates. Flexible, so you don't need to be.
2017-06-25 06:21:48 +00:00
2018-06-26 09:31:18 +00:00
[](https://raw.githubusercontent.com/renovatebot/renovate/master/license)
[](https://codecov.io/gh/renovatebot/renovate)
2017-07-03 07:55:49 +00:00
[](https://gitter.im/renovate-app/Lobby?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2018-06-26 09:31:18 +00:00
[](https://renovatebot.com/)
2017-06-25 06:24:51 +00:00
2017-12-27 12:15:55 +00:00
## Why Use Renovate?
2017-01-12 19:56:46 +00:00
2018-05-28 07:26:22 +00:00
- Receive automated Pull Requests whenever dependencies need updating. Or whenever you schedule it for.
- Renovate discovers and processes all dependency files in a repository (e.g. supports
2017-12-27 12:15:55 +00:00
monorepo architecture such as lerna or yarn workspaces)
2018-05-28 07:26:22 +00:00
- Extremely customisable behaviour via configuration files or within your `package.json`
- Use eslint-like shared config presets for ease of use and simplifying configuration
- Update lock files natively in the same commit, including immediately resolving conflicts whenever PRs are merged
- Supports GitHub, GitLab (APIv4) and VSTS. BitBucket is a WIP.
- Open source (installable via npm/yarn) so can be self-hosted or used for free via GitHub App
2017-10-06 09:58:24 +00:00
2018-02-04 07:18:55 +00:00
## Who Uses Renovate?
Renovate was released in 2017 and is now widely used in the developer community. Example users include the following GitHub organisations:
[<img align="left" src="https://avatars1.githubusercontent.com/u/2034458?s=80&v=4" alt="algolia" title="algolia" hspace="10"/> ](https://github.com/algolia )
[<img align="left" src="https://avatars0.githubusercontent.com/u/139426?s=80&v=4" alt="angular" title="angular" hspace="10"/> ](https://github.com/angular )
[<img align="left" src="https://avatars2.githubusercontent.com/u/131524?s=80&v=4" alt="mozilla" title="mozilla" hspace="10"/> ](https://github.com/mozilla )
[<img align="left" src="https://avatars2.githubusercontent.com/u/33676472?s=80&v=4" alt="uber-workflow" title="uber-workflow" hspace="10"/> ](https://github.com/uber-workflow )
[<img align="left" src="https://avatars1.githubusercontent.com/u/22247014?s=80&v=4" alt="yarnpkg" title="yarnpkg" hspace="10"/> ](https://github.com/yarnpkg )
< br / > < br / > < br / > < br / > < br / >
2017-12-27 12:12:06 +00:00
## The Renovate Approach
2017-10-06 09:58:24 +00:00
2018-05-28 07:26:22 +00:00
- Everyone can benefit from automation, whether it's a little or a lot
- Renovate should not cause you to change your workflow against your wishes - don't enforce opinions on users
- All behaviour should be configurable, down to a ridiculous level if desired
- Autodetect settings wherever possible (to minimise configuration) but always allow overrides
2017-01-12 19:56:46 +00:00
2017-12-27 12:12:06 +00:00
## Using Renovate
2017-06-02 20:46:58 +00:00
2018-03-02 14:28:50 +00:00
The easiest way to use Renovate if you are on GitHub is to use the Renovate app. Go to
2018-04-29 12:25:38 +00:00
[https://github.com/marketplace/renovate ](https://github.com/marketplace/renovate ) to install
2017-12-02 19:29:55 +00:00
it now.
2017-06-02 20:46:58 +00:00
2017-06-05 21:00:01 +00:00
## Configuration
2018-06-26 09:31:18 +00:00
Please see https://renovatebot.com/docs/ for documentation, and in particular https://renovatebot.com/docs/configuration-options/ for a list of configuration options.
2017-01-15 18:57:20 +00:00
2018-04-29 12:25:38 +00:00
You can also raise an issue in https://github.com/renovatebot/config-help if
2017-12-02 19:29:55 +00:00
you'd like to get your config reviewed or ask any questions.
2017-10-08 07:12:16 +00:00
2017-12-27 12:12:06 +00:00
## Self-Hosting
2017-01-15 18:57:20 +00:00
2018-06-26 09:31:18 +00:00
If you are not on GitHub or you prefer to run your own copy of Renovate, then you can easily run your own copy. Please see [docs/self-hosting.md ](https://github.com/renovatebot/renovate/blob/master/docs/self-hosting.md ) for instructions. There is also a commercially licensed [Renovate Pro Edition ](https://renovatebot.com/pro ) available for GitHub Enterprise.
2018-02-19 19:06:05 +00:00
2018-03-05 08:08:20 +00:00
## Contributing
2018-03-19 09:52:28 +00:00
If you would like to contribute to Renovate or get a local copy running for some other reason, please see the instructions in [contributing.md ](.github/contributing.md ).
2018-03-05 08:08:20 +00:00
2018-02-19 19:06:05 +00:00
## Security / Disclosure
2018-06-26 09:31:18 +00:00
If you discover any important bug with Renovate that may pose a security problem, please disclose it confidentially to security@renovatebot.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.
