Renovate Bot Guide¶
This guide explains how to enable and manage the automated dependency updates for this repository.
1. Enable Renovate¶
Since this is a GitHub repository, you'll need to enable the Renovate app:
- Go to github.com/apps/renovate.
- Click Install.
- Select your repository (
jerdaw/dotfiles). - Click Install.
Once installed, Renovate will detect the .github/renovate.json configuration file we created.
2. The Onboarding PR¶
Renovate will typically open an "Onboarding PR" properly configured. Since we already have a configuration file, it might just start working or open a "Pin Dependencies" PR.
- Action: Merge the Onboarding PR if one appears.
3. Workflow¶
- Schedule: Updates run every weekend (Saturday/Sunday).
- Grouping: Tools in
mise.tomlare grouped into a single PR named "chore(deps): update mise tools". - Automerge: Patch updates for
node,python, andrustwill automerge if CI passes.
4. Manual Triggers¶
If you want to trigger an update check manually (e.g., to verify the config):
- Go to the "Dependency Dashboard" issue (Renovate creates this).
- Click the check box for "Check for updates".
5. Troubleshooting¶
If PRs aren't being created:
- Check the Renovate Dashboard.
- Ensure CI has passed on the default branch.
- Check the "Dependency Dashboard" issue in your repo.
6. Verifying Renovate Status¶
Check that Renovate is actively monitoring your repository:
Quick Check¶
- Look for the "Dependency Dashboard" issue in your repository
- The issue should show:
- Last run timestamp
- Pending updates (if any)
- Rate limit status
Expected Behavior¶
| Indicator | Healthy | Unhealthy |
|---|---|---|
| Dashboard issue exists | ✅ | ❌ Contact support |
| Last run < 7 days ago | ✅ | ⚠️ Check config |
| No "rate limited" errors | ✅ | ⚠️ Wait or upgrade |
Common Issues¶
- No PRs created: Check if automerge is consuming them
- "Disabled" status: Repository may need re-enabling
- JSON errors: Validate
renovate.jsonsyntax