itsthejoker/renovate-config

renovate-config

This is Shareable Config Presets for SpotOn. It contains wide-use Renovatebot configs, based on our toolset and mindset.

• Usage
• Development notes
• Useful links
  • Renovate App and presets configuration
  • Repos configuration
• Troubleshooting

Usage

If Renovate has already been activated for repo

1. Check for renovate.json in possible locations.

2. Change renovate config to:

   {
     "$schema": "https://docs.renovatebot.com/renovate-schema.json",
     "extends": [
       "local>SpotOnInc/renovate-config"
     ]
   }

Go to step 3. below.

Otherwise:

0. If the repo is too much outdated - prefer to update manually as much as you can before merging Renovate init PR.

1. Activate Renovatebot Github App for your repo or ask Github org administrators.

2. Renovate will create [init PR for the new repo - open it and check that it has:

   {
     "$schema": "https://docs.renovatebot.com/renovate-schema.json",
     "extends": [
       "local>SpotOnInc/renovate-config"
     ]
   }

3. (Optional) We recommend moving the config to .github/renovate.json5.

4. Be sure that the Dependency graph and Dependabot alerts are enabled for the repo. Details.

5. Merge PR and relax.
   Renovate will create PRs based on provided schedules. By default - you will see Renovate PRs on Mondays.

Development notes

To change the default config, please edit default.template.json5 and create PR.

default.json will be automatically generated and added after your PR will be merged.

That needs to describe what settings do and save renovate-config/default.json name magic which is not present for .json5.

---

In case when new default.json config does not apply more than 6 hours - create test repo and copy-paste the whole default.json, but rename it to renovate.json. Renovatebot will test the configuration and create issues if it found problems with the configuration. Or you can ask ChatGPT :)

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 closed PR - just rename 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
  Ie: 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