Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dxw/renovate-config
Default configurations for Renovate in dxw repositories
https://github.com/dxw/renovate-config
configuration delivery-plus renovate
Last synced: 21 days ago
JSON representation
Default configurations for Renovate in dxw repositories
- Host: GitHub
- URL: https://github.com/dxw/renovate-config
- Owner: dxw
- Created: 2023-09-22T13:50:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-02T20:47:32.000Z (about 1 month ago)
- Last Synced: 2024-12-06T19:41:36.227Z (28 days ago)
- Topics: configuration, delivery-plus, renovate
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# dxw Standardised Renovate Configs
**These are under development, and may change without warning. We recommend not using them (yet) for anything which is mission critical.**
This repository holds some standard configurations for [Renovate](https://www.mend.io/renovate/), our preferred dependency update bot.
## Behaviour
### Default
The default config (`default.json`) is intended as a good starting point for any repository. It implements the following behaviours:
- Creates a "Dependency Dashboard" issue for the repository, for tracking the state of updates and triggering some behaviours
- Automatically merges patch updates to all dependencies between 10am and 4pm
- Automatically merges updates from [linters](https://docs.renovatebot.com/presets-packages/#packageslinters) and [testing tools](https://docs.renovatebot.com/presets-packages/#packagestest). Note that the definitions for these packages are not exhaustive, so some linters and testers will still have PRs opened as normal.
- Opens a PR for all updates, and requires all tests to pass
- Requires all major updates to have a PR explicitly opened via the Dependency Dashboard
- Waits three days following a package release before opening PRs (to allow time for broken versions to be yanked)
- For NPM packages (which have a higher churn), waits five days.
### Internal
The internal config (`internal.json`) is intended for dxw internal repos where the impact of changes is generally lower. In addition to the defaults, it implements the following behaviours:
- Automatically merges minor updates, as well as patch
- Combines patch updates and minor updates into a single pull request
## How to use
1. Install the [Renovate app](https://github.com/apps/renovate) for the repository, if not already installed.
1. Update the `renovate.json` file to extend our standard configuration:
```json
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["github>dxw/renovate-config"]
}
```
or, for most internal repositories:
```json
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["github>dxw/renovate-config:internal"]
}
```
If this is a new installation of Renovate then it will automatically open a new PR for this file.
1. Consider if these presets meet the needs of the repository. These are _not_ intended to be prescriptive, just a starting point. If you need to, change any other [configuration options](https://docs.renovatebot.com/configuration-options/) specific to the repository.
1. If a new installation, merge the Renovate configuration PR.
1. If you have branch protection turned on and it requires reviews, make sure you either [bypass protections for Renovate or install renovate-approve](https://docs.renovatebot.com/key-concepts/automerge/#pull-requests-required). The recommended path is to use the bypass protections unless you need approvals for another workflow.
### Things to be aware of
By default, this configuration will use GitHub's own automerging behaviour. This will merge a branch once all _required_ actions have passed, so you should make sure that test suites etc are configured correctly.