renovate-config
Ridedott's base config for Renovate[bot].
Getting Started
The project has no runtime and acts as a shareable base config. It can only be used by other projects implementing Renovate[bot].
Prerequisites
Minimal requirements to set up the project:
- Node.js v10, installation instructions can be found on the official website, a recommended installation option is to use Node Version Manager. It can be installed in a few commands.
- A package manager like Yarn or npm. All instructions in the documentation will follow the npm syntax.
- Optionally a Git client.
Installing
Start by cloning the repository:
git clone git@github.com:ridedott/renovate-config.git
In case you don't have a git client, you can get the latest version directly by using this link and extracting the downloaded archive.
Go the the right directory and install dependencies:
cd renovate-config
nvm use
npm install
That's it! You can now go to the next step.
Tests
This repository does not contain any source code, just the configuration, so no tests are present.
Formatting
This project uses Prettier to automate formatting. All supported files are being reformatted in a precommit hook. You can also use one of the two scripts to validate and optionally fix all of the files:
npm run format
npm run format:fix
Publishing
Publishing is handled in an automated way and must not be performed manually.
Each commit to the master branch is automatically deployed to the NPM registry
with a version specified in package.json
. All other commits are published as
pre-releases.
Usage
Add a Renovate configuration to your project and use
"extends": ["local>ridedott/renovate-config"]
to include the options defined
as defaults in the ./default.json configuration:
{
"extends": ["local>ridedott/renovate-config"],
"packageRules": [
{
"enabled": false,
"packageNames": ["@types/node"],
"updateTypes": ["major"]
}
]
}
The default configuration is currently set to:
{
"automergeSchedule": ["after 10am and before 4pm every weekday"],
"commitMessageAction": "update",
"postUpdateOptions": ["npmDedupe"],
"rangeStrategy": "bump",
"rebaseStalePrs": true,
"recreateClosed": true,
"schedule": ["after 10am and before 4pm every weekday"]
}
We use the merge-me github action to auto merge PRs and the
hosted renovate bot which runs 24/7 we need to use the schedule
configuration
above to ensure that renovate only runs between the desired hours. Not having
this configuration allows renovate bot to rebase PRs outside the specified
hours which potentially leads to the CI becoming green and merge-me auto
merging the PR. Which led to outages of breaking runtimes that we didn't
catch.
Contributing
See CONTRIBUTING.md.
Built with
Automation
Versioning
This project adheres to Semantic Versioning v2.