README.md

Shared Renovate Config

Shared config for the renovate service.

---

^{Daniel Bannert's open source work is supported by the community on GitHub Sponsors}

---

Usage

Go to https://github.com/apps/renovate, ask a GitHub admin of the organisation if you need help on how to do this step.

Default preset

{
    "extends": [
        "github>anolilab/renovate-config"
    ]
}

Features

• Use Europe/Berlin timezone by default
• Auto merge patch and minor version, if they pass tests
• Support npm/Node.js ecosystem
• Support GitHub-Actions updates with hash version
• Support Docker ecosystem
• Defined package groups like TypeScript, Prettier, Linters, TypeDoc, Sass, Less, Stylus, PostCSS, Vite, Rollup, Visulima, Vitest
• Enhanced security with vulnerability alerts and auto-merge for security updates
• Smart rate limiting (4 PRs per hour, 10 concurrent PRs)
• Package stability checks with 3-day waiting period
• Automated maintenance with weekly lock file updates
• Comprehensive labeling system for different update types
• Scheduled updates for specific package groups (ESLint, types on weekends)
• Semantic commit messages for all updates:
  • Security updates: fix(security)
  • Build tools (Vite, Rollup): build(deps-dev)
  • Style tools (ESLint, Prettier): style(deps-dev)
  • Documentation tools (TypeDoc): docs(deps-dev)
  • CI/CD (GitHub Actions): ci(deps)
  • Docker: build(deps)
  • Regular dependencies: chore(deps) or fix(deps) for non-major updates
• Intelligent auto-merge rules for different package types
• Docker and GitHub Actions specific configurations with proper labeling

References

• Renovate Docs
• Configuration Options | Renovate Docs
• Default Presets | Renovate Docs

Useful links

• How Renovate find/create/update PRs
  TL;DR: Renovatebot checks branch names and PR titles. If PR is not found to match the branch - Renovatebot will create a new PR.
  To recreate a closed PR, rename the closed PR.

Renovate App and presets configuration

• Managing config for many repositories

• Shareable Config Presets

  • Organization level presets - myorg/renovate-config/default.json magic name
  • GitHub-hosted Presets
  • Contributing to presets
  • Preset Versioning

• Managers: Supported, configuration, disabling, etc.

• Renovate App on GitHub Secrets Encryption

• Known limitations
  Example: GitHub hosted app Mend checks each active repository roughly every three hours, if no activity has been seen before then (merged PRs, etc).

  • No rebasing if you have made edits (conflicting with pre-commit auto-fixes)

• onboardingConfigFileName (self-hosted only).
  Useful to change onboarding Renovate config file location.

• Docker Registries authentication

Repos configuration

• Configuration location

• Overriding global configs

• Scheduling syntax

  • Schedule Presets

• Changing the Semantic Commit type

• How to edit branch names, commit messages, PR titles, and PR content

• Docker Digest pinning and Updating

• Separate patch and minor releases of dependencies into separate PRs.
  More details here

• Group all packages starting with abc together in one PR

• :pinVersions - maintain a single version only and not SemVer ranges

• :rebaseStalePrs - Rebase existing PRs any time the base branch has been updated.

• Update package/GHA references in Markdown files

Troubleshooting

• Troubleshooting docs
• Renovate dashboard

Contributing

If you would like to help take a look at the list of issues and check our Contributing guild.

Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Credits

• Daniel Bannert
• All Contributors

License

The anolilab renovate-config is open-sourced software licensed under the MIT license