docs: short readme

This commit is contained in:
hh committed 2026-10-08 21:34:52 +02:00
1 parent a8a9406a3d
commit e4460402b0
1 file changed
+3 -42
+3 -42
View File
@@ -1,48 +1,9 @@
# renovate # renovate
Shared Renovate preset for project repositories. Public on purpose: most project Shared Renovate preset, public so private repos can extend it. A project's whole `renovate.jsonc`:
repos are private and some are public, and a preset that lives in a private repo
resolves for the bot only, while leaking the private repo path to everyone else.
There are no secrets here, only rules.
Use it from a project repo as the whole of its `renovate.jsonc`:
```json ```json
{ { "extends": ["local>templates/renovate"] }
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["local>templates/renovate"]
}
``` ```
What it does: docker digests, patches and minors merge themselves after a Docker digests, patches and minors automerge after three days into the default branch; code dependencies go into one PR on `dev`; majors wait for the dashboard. The repo needs a `dev` branch, the `renovate`, `wait-3d` and `deps-code` labels, and a line in `repositories` of `projects/personal/renovate/renovate-config.js` in `infra/komodo`. `@biomejs/biome` is held at 2.5.13 (2.5.15 breaks Svelte attribute quotes).
three day wait; docker majors and database majors wait for a click on the
dependency dashboard; code dependencies (npm, pip, go.mod, actions) are
collected into one pull request per repo, which merges itself after the same
three day wait; code majors wait for a click on the dependency dashboard and
merge themselves once approved. Registries without a release timestamp get the
`wait-3d` label instead, and the age gate merges those. The edge (`caddy/**`),
`_legacy/**` and worktree compose files are out of scope.
Updates are split across two base branches. Images target the default branch,
so an image update deploys as soon as it merges. Code dependencies target
`dev` and never touch the default branch on their own; you pull `dev` and
merge it yourself when you want that code in production. The split is two
`matchBaseBranches` rules, so the same update is never offered on both
branches. A repo using this preset therefore needs a `dev` branch.
`@biomejs/biome` is held at 2.5.13 for now: 2.5.15 rewrites the quotes inside
Svelte attribute expressions and breaks the markup. Drop the rule once a fixed
release is out.
The repo has to carry the `renovate`, `wait-3d` and `deps-code` labels before
the first run: Renovate fails on a label that does not exist. It also has to
have a `dev` branch, otherwise Renovate skips that base branch and code
updates are never proposed.
Extending this preset does NOT subscribe a repo to anything. The bot only visits
repos listed in `repositories` in its own config
(`projects/personal/renovate/renovate-config.js` in `infra/komodo`).
`infra/komodo` deliberately does not use this preset: it is the private infra
repo, its scope is a set of `includePaths` and it only ever looks at
docker-compose.