Renovate's documentation has a lot of pages. To ease you into using Renovate we created reading lists. The reading lists contain the essential information for each type of user.
How much you should read depends on how much you want to customize Renovate's behavior.
How to use this page¶
We created reading lists for these types of users:
Start with the "Beginners" reading list. If you're self-hosting or need to update private packages, complete the relevant reading lists for those.
I don't know where to start¶
If you're new to Renovate, you should:
- Use the Mend-hosted GitHub App, or let somebody else host Renovate for you
- Stick with the
- Use the Dependency Dashboard (
config:baseenables it automatically)
- Read the pages in the "Beginners" list
- Only create custom Renovate configuration when really needed
Start by reading:
- Installing & Onboarding
- Key concepts, Dependency Dashboard
- Use Cases
- Running Renovate
- Known limitations
- Release notes for major versions
First, complete the "Beginners" reading list. Read this list after experiencing Renovate's default behavior, once you really want/need to make changes to Renovate's behavior.
- Key concepts, presets
- Key concepts, Renovate scheduling
- Key concepts, automerge
- Key concepts, pull requests
- Noise Reduction
Skim the repository configuration options to learn about the kind of customizations you can make to Renovate. Feel free to read up on anything that looks interesting to you.
First, complete the "Beginners" and the "Intermediate" reading list. Then read:
- Define your own regex manager with
- Shareable config presets
If you're going to self-host Renovate then read:
If you want Renovate to update private packages then read: