|
2 | 2 |
|
3 | 3 | This page explains what we (the Renovate maintainers) recommend you do to update your dependencies.
|
4 | 4 |
|
5 |
| -We'll cover starting a new project, updating a year-old project, and updating a project with five year old dependencies. |
6 |
| -We explain why you should update often, and how to nudge your team to update their dependencies. |
7 |
| - |
8 | 5 | ## General recommendations
|
9 | 6 |
|
10 | 7 | In general, you should:
|
11 | 8 |
|
12 | 9 | - Run Renovate on _every_ repository
|
13 |
| -- Use the `config:best-practices` preset instead of `config:recommended` |
| 10 | +- Use the `config:best-practices` preset, instead of the `config:recommended` preset |
14 | 11 | - Use the Dependency Dashboard issue (it's on by default)
|
15 | 12 | - Update your dependencies often
|
16 | 13 | - Read the changelogs for the updates
|
@@ -45,17 +42,17 @@ The [`config:best-practices` preset](./presets-config.md#configbest-practices) h
|
45 | 42 |
|
46 | 43 | ```json
|
47 | 44 | {
|
48 |
| - "configMigration": true, |
49 | 45 | "extends": [
|
50 | 46 | "config:recommended",
|
51 | 47 | "docker:pinDigests",
|
52 | 48 | "helpers:pinGitHubActionDigests",
|
| 49 | + ":configMigration", |
53 | 50 | ":pinDevDependencies"
|
54 | 51 | ]
|
55 | 52 | }
|
56 | 53 | ```
|
57 | 54 |
|
58 |
| -The next sections explain each part of the preset. |
| 55 | +The next sections explain what each part of the preset does. |
59 | 56 |
|
60 | 57 | #### Config migration
|
61 | 58 |
|
@@ -127,6 +124,14 @@ Finally, when you're updating often, you'll start looking for ways to automate t
|
127 | 124 | You may start to [`automerge`](./configuration-options.md#automerge) development dependencies like Prettier, or ESLint when the linter passes.
|
128 | 125 | Or you may decide to automerge any `patch` type upgrades, by using the [`default:automergePatch`](./presets-default.md#automergepatch) preset.
|
129 | 126 |
|
| 127 | +#### Wait two weeks before automerging third-party dependencies |
| 128 | + |
| 129 | +If you `automerge` third-party dependencies, we recommend setting [`minimumReleaseAge`](./configuration-options.md#minimumreleaseage) to `"14 days"`. |
| 130 | +By waiting two weeks before automerging the dependencies, you give the upstream registries time to pull malicious dependencies, before Renovate merges them. |
| 131 | +If you want a third-party dependency update _now_, instead of waiting two weeks, you can request the update from the Dependency Dashboard. |
| 132 | + |
| 133 | +#### Use GitHub Pull Request Merge Queues |
| 134 | + |
130 | 135 | You may also start using [GitHub's pull request merge queues](./key-concepts/automerge.md#github-merge-queue) to speed up the merge process.
|
131 | 136 | Renovate does not support GitLab's Merge Trains, see [issue #5573](https://github.com/renovatebot/renovate/issues/5573).
|
132 | 137 |
|
@@ -276,5 +281,5 @@ Martin Fowler has two great resources:
|
276 | 281 | - The free page [Patterns for Managing Source Code Branches](https://martinfowler.com/articles/branching-patterns.html) to help you decide what Git branch pattern to use
|
277 | 282 | - The book [Refactoring, Improving the Design of Existing Code](https://martinfowler.com/books/refactoring.html) to help your developers gradually refactor to clean, modular and easy to read code
|
278 | 283 |
|
279 |
| -The `git bisect` command can help you find out which commit introduced a bug, or other behavior change. |
| 284 | +The `git bisect` command can help you find the commit that introduced a bug, or other behavior change. |
280 | 285 | Read the [ProGit 2 book, section on binary search](https://git-scm.com/book/en/v2/Git-Tools-Debugging-with-Git#_binary_search) to learn more.
|
0 commit comments