@vizworx/renovate-config

VizworX Renovate Configuration (@vizworx/renovate-config)

A renovate config with common settings for VizworX

This is a collection of Renovate config presets that are used on VizworX projects. You can extend the base config, or any of the named configs.

Getting Started - Enabling Renovate on your repository

• for GitHub
• for GitLab
  • go to Renovate Dashboard to add your project,
  • accept Renovate Bot PR

Usage

You don't need to install this package, since Renovate will automatically pull it in if you extend @vizworx or @vizworx:subPackageName

Recommended configuration for projects:

This will enable all of the configurations listed below, however you can use them individually if you would prefer.

renovate.json

{
  "extends": [
    "@vizworx"
  ]
}

Renovate Configuration

renovate.json

Release Notes :

Enables showing the release notes from GitHub

{
  "extends": [
    "@vizworx:releaseNotes"
  ]
}

Labels:

Automatically apply common VizworX labels such as 🤖 Dependency to PRs

{
  "extends": [
    "@vizworx:labels"
  ]
}

Node:

Always update to the latest LTS of Node

{
  "extends": [
    "@vizworx:node"
  ]
}

Automerge:

Pinned PRs should be automerged, and should skip the CI system

{
  "extends": [
    "@vizworx:automerge"
  ]
}

Stability:

Wait a few days to help ensure new dependency versions are stable, and that new patches aren't being released.

• Major - Wait 7 days
• Minor - Wait 2 days
• Patch - Wait 2 days

{
  "extends": [
    "@vizworx:stability"
  ]
}

Show All:

Remove limits on the number of dependency PRs that can exist at one time, or be created in one hour, and enable the Master Issue to keep track of upcoming (unstable) PRs

{
  "extends": [
    "@vizworx:showAll"
  ]
}

Docker:

Adjust default behaviours for RenovateBot and Docker, primarily disabling creation of major updates for docker which became default in v25.0.0.

{
  "extends": [
    "@vizworx:docker"
  ]
}

Group - React:

Group all React-related packages together to ensure we don't have a mismatch between closely linked dependencies such as react and react-dom, or react-dom and @hot-loader/react-dom.

{
  "extends": [
    "@vizworx:groupReact"
  ]
}

Group - All:

Enable commonly used package groups

{
  "extends": [
    "@vizworx:groupAll"
  ]
}

Outside Business Hours:

Only run Renovate outside of business hours, to reduce the amount of PR noise and CI load generated during the day. Renovate will run before 5am and after 10pm on weekdays, and any time during the weekends.

{
  "extends": [
    "@vizworx:outsideBusinessHours"
  ]
}

Quiet Noisy Packages:

Some packages, such as the AWS SDK release a new package on a frequent schedule. This will limit them to only update once a week (on Monday before 3am).

{
  "extends": [
    "@vizworx:quietNoisyPackages"
  ]
}

License

MIT © VizworX