2.8 KiB
Reading list
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:
- Beginners
- Intermediate
- Advanced
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 Renovate App, or let someone else host Renovate for you
- Stick with the
config:recommendedpreset - Use the Dependency Dashboard (
config:recommendedenables it automatically) - Read the pages in the "Beginners" list
- Only create custom Renovate configuration when really needed
Beginners
Start by reading:
- Installing & Onboarding
- Key concepts, Dependency Dashboard
- Use Cases
- Running Renovate
- Troubleshooting
- Known limitations
- Release notes for major versions
Intermediate
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.
- Upgrade best practices
- 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.
Advanced
First, complete the "Beginners" and the "Intermediate" reading list. Then read:
- Define your own custom manager with
customManagers(previouslyregexManagers) - Define your own custom datasources with
customDatasources - Shareable config presets
Self-hosting Renovate
If you're going to self-host Renovate then read:
Private packages
If you want Renovate to update private packages then read: