Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 2.6 KB

creating-editing-renovate-presets.md

File metadata and controls

45 lines (27 loc) · 2.6 KB
Raw

Creating/editing Renovate presets

Renovate comes with default presets that you can find in the lib/config/presets/internal directory. You can suggest changes to the presets with a pull request.

Follow the rules below to increase the chance that your pull request gets merged.

General rules

  1. Avoid creating presets for problems which can be fixed upstream
  2. The internal preset should help a significant number of Renovate users

Specific rules

Group presets

We have multiple kinds of group: presets, with different rules.

Rules for group:monorepos preset
  1. Only group dependencies that must be updated together
Rules for group:recommended presets
  1. The group:recommended preset is for related dependencies which aren't from a monorepo but which usually need to be updated together (as separate PRs may each break)
Rules for group:* presets
  1. Finally, any other group:* presets can be added if they are beneficial to a wide number of users
  2. They don't need to be added to group:recommended, meaning that users will "opt in" to them one-by-one and not get them automatically from config:recommended, which includes group:monorepos and group:recommended

Rules for replacement presets

  1. Replacement PRs should ideally propose a replacement only once the user is on a compatible version, by specifying a compatible matchCurrentVersion constraint
  2. If no compatible replacement upgrade is possible, it's acceptable to propose an incompatible one (e.g. a major version upgrade)
  3. Replacements should update the user to the first recommended version of the new dependency and not include any new changes - whether breaking or not - if they can be avoided, in short: pin the new version

If possible, replacement presets should give the user a replacement version that is functionally identical to the last version under the old name. We only want a user's tests to fail because of broken references to the old package name, and not because the maintainer(s) changed the behavior of the package.

Rules for monorepo presets

  1. The primary use case of monorepo presets is finding packages from the same origin source repository which should be updated together
  2. Packages from the same repository which are developed and versioned independently do not need to be grouped as a monorepo, but in many cases we still do
  3. Packages from separate repositories but which are released together and dependent on each other may also be added to the "monorepo" definitions even if not strictly true