diff --git a/README.md b/README.md index 9f66e5f..c9e5a27 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,10 @@ Example: ./scripts/toggle-headsdown-plugin.sh local ``` +## Dependency update automation + +This repo uses Renovate to keep `@headsdown/sdk` and other routine dependencies current. New SDK releases open bot PRs automatically, and eligible updates can automerge after required CI checks pass. In normal maintenance flow, do not manually edit `@headsdown/sdk` versions unless you are intentionally overriding Renovate behavior. + ## License MIT diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..b434c31 --- /dev/null +++ b/renovate.json @@ -0,0 +1,27 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": ["config:recommended"], + "labels": ["dependencies"], + "timezone": "Etc/UTC", + "schedule": ["before 5am every weekday"], + "packageRules": [ + { + "description": "Keep @headsdown/sdk current with CI-gated automerge for routine releases.", + "matchPackageNames": ["@headsdown/sdk"], + "matchUpdateTypes": ["patch", "minor", "pin", "digest"], + "groupName": "@headsdown/sdk", + "automerge": true, + "automergeType": "pr", + "platformAutomerge": true, + "rebaseWhen": "behind-base-branch" + }, + { + "description": "Reduce noise by grouping routine development dependency updates.", + "matchManagers": ["npm"], + "matchDepTypes": ["devDependencies"], + "matchUpdateTypes": ["patch", "minor", "pin", "digest"], + "groupName": "development dependencies", + "groupSlug": "dev-dependencies" + } + ] +}