README.md

Renovate Presets

Collection of out-of-the-box Renovate config presets for various PLs, frameworks, and tools

Getting Started

1. Choose presets for your project
2. Extend them in your Renovate config file

renovate.json

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": ["github>aentwist/renovate//presets/default"]
}

Feel free to combine these with other presets, such as Renovate default presets.

Config Preset Features

default

github>aentwist/renovate//presets/default

• Extends config:best-practices, :preserveSemverRanges, and :automergeBranch
• Require manual action for major updates
• Automerge minor updates except major version zero

gitlab/labels

github>aentwist/renovate//presets/gitlab/labels

• Add GitLab-style labels to merge requests and Dependency Dashboard issues

node

github>aentwist/renovate//presets/node

• Extends npm:unpublishSafe
• dedupe after updating
• Only use LTS node releases
• Group jsdom

pre-commit/*

• Add a custom manager for additional_dependencies*
• Group pre-commit mirrors / hook repos with their respective packages
• Wait to update pre-commit hook repos for npm-based packages until they are unpublish-safe

*Custom manager for additional_dependencies

Adding handling for additional_dependencies to Renovate is not trivial. Ideally this will be implemented someday. Until then, a custom manager with a regular expression has been implemented to accomplish the same task. For it to match your additional_dependencies you must include a special comment above each one.

# renovate: KEY=VALUE...

It MUST specify the datasource. For example, datasource=npm.
It MAY specify the versioning (default: semver). Add a versioning token after the datasource token, delimited by a space. For example, versioning=pep440.

Here is a config example,

.pre-commit-config.yaml

repos:
  - repo: https://github.com/aentwist/pre-commit-mirrors-commitlint
    rev: v19.0.3
    hooks:
      - id: commitlint
        stages: [commit-msg]
        additional_dependencies:
          # renovate: datasource=npm
          - [email protected]
          # renovate: datasource=npm
          - "@commitlint/[email protected]"

For more information, see Custom Manager Support using Regex.

pre-commit/javascript

github>aentwist/renovate//presets/pre-commit/javascript

Examples

Vue with pre-commit and GitLab labels

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": [
    "github>aentwist/renovate//presets/default",
    "github>aentwist/renovate//presets/node",
    "github>aentwist/renovate//presets/pre-commit/javascript",
    "github>aentwist/renovate//presets/gitlab/labels"
  ]
}

See Also

• ignorePresets