Skip to content

Commit

Permalink
docs(gomod): clarify major updates limitations (#31119)
Browse files Browse the repository at this point in the history
  • Loading branch information
rarkins authored Aug 30, 2024
1 parent 4f9a8f0 commit 0831777
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions lib/modules/manager/gomod/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,14 @@ Rules from this list are converted to environment variable directives if they ma
- No `hostType` is defined, or
- `hostType` is `go`, or
- `hostType` is a platform (`github`, `gitlab`, `azure`, etc.)

### Major upgrades of dependencies

Major upgrades in Go are different from most other ecosystems, because both the version and module name need to be changed.
It is very common that such upgrades require changes to application code, which Renovate doesn't do.

By default, Renovate will make such change in the `go.mod` files but nothing else - the rest is up to you.
If you add `gomodUpdateImportPaths` to `postUpdateOptions` then Renovate will also use a third-party tool to migrate import paths within application code, but there may still be actual application logic which needs to be changed too.

Ultimately: it is known and unavoidable that the majority of major Go upgrades won't be immediately mergeable.
You might prefer to configure such major updates with `dependencyDashboardApproval=true` so that you can request them on demand, on supported platforms.

0 comments on commit 0831777

Please sign in to comment.