diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md
index ba82a12c7dafdcd5e5c662a2ff0dedaa7be744e1..582df2784a65644d7d3114b27d3fdd3d8f52c84c 100644
--- a/docs/usage/configuration-options.md
+++ b/docs/usage/configuration-options.md
@@ -1487,7 +1487,8 @@ If enabled Renovate will pin Docker images by means of their SHA256 digest and n
## postUpdateOptions
-- `gomodTidy`: Run `go mod tidy` after Go module updates
+- `gomodTidy`: Run `go mod tidy` after Go module updates. This is implicitly enabled for major module updates.
+- `gomodUpdateImportPaths`: Update source import paths on major module updates, using [mod](https://github.com/marwan-at-work/mod)
- `npmDedupe`: Run `npm dedupe` after `package-lock.json` updates
- `yarnDedupeFewer`: Run `yarn-deduplicate --strategy fewer` after `yarn.lock` updates
- `yarnDedupeHighest`: Run `yarn-deduplicate --strategy highest` (`yarn dedupe --strategy highest` for Yarn >=2.2.0) after `yarn.lock` updates
diff --git a/docs/usage/golang.md b/docs/usage/golang.md
index aa02915b755ab940d2fd492c7a0503fe2fd57ef4..fc3e1d59b14578a7911923495d77bdb47a82a154 100644
--- a/docs/usage/golang.md
+++ b/docs/usage/golang.md
@@ -14,7 +14,9 @@ Renovate supports upgrading dependencies in `go.mod` files and their accompanyin
1. Renovate resolves the dependency's source repository and checks for SemVer tags if found. Otherwise commits and `v0.0.0-....` syntax will be used
1. If Renovate finds an update, Renovate will update `go.mod` to the new value
1. Renovate runs `go get` to update the `go.sum` files
-1. If the user has enabled the option `gomodTidy` in the [`postUpdateOptions`](https://docs.renovatebot.com/configuration-options/#postupdateoptions) array, then Renovate runs `go mod tidy`, which itself can update `go.mod` and `go.sum`
+1. If the user has enabled the option `gomodUpdateImportPaths` in the [`postUpdateOptions`](https://docs.renovatebot.com/configuration-options/#postupdateoptions) array, then Renovate uses [mod](https://github.com/marwan-at-work/mod) to update import paths on major updates, which can update any Go source file
+1. If the user has enabled the option `gomodTidy` in the [`postUpdateOptions`](https://docs.renovatebot.com/configuration-options/#postupdateoptions) array, then Renovate runs `go mod tidy`, which itself can update `go.mod` and `go.sum`.
+ 1. This is implicitly enabled for major updates
1. `go mod vendor` is run if vendored modules are detected
1. A PR will be created with `go.mod`,`go.sum`, and any updated vendored files updated in the one commit
1. If the source repository has either a "changelog" file or uses GitHub releases, then Release Notes for each version will be embedded in the generated PR
diff --git a/lib/config/definitions.ts b/lib/config/definitions.ts
index cd825d0e120c584edd498de485367721193f47e2..0d357651a5d5bb82d3ff6e75945ad7e21fabacfd 100644
--- a/lib/config/definitions.ts
+++ b/lib/config/definitions.ts
@@ -1498,6 +1498,7 @@ const options: RenovateOptions[] = [
type: 'array',
default: [],
allowedValues: [
+ 'gomodUpdateImportPaths',
'gomodTidy',
'npmDedupe',
'yarnDedupeFewer',
diff --git a/lib/manager/gomod/__snapshots__/artifacts.spec.ts.snap b/lib/manager/gomod/__snapshots__/artifacts.spec.ts.snap
index dc2e8fb060597401e8766659175cb19dbe603d05..9fcb09e549ea2ad34409425a58fa48b778d04cf3 100644
--- a/lib/manager/gomod/__snapshots__/artifacts.spec.ts.snap
+++ b/lib/manager/gomod/__snapshots__/artifacts.spec.ts.snap
@@ -73,6 +73,194 @@ Array [
]
`;
+exports[`.updateArtifacts() skips updating import paths for gopkg.in dependencies 1`] = `
+Array [
+ Object {
+ "file": Object {
+ "contents": "New go.sum",
+ "name": "go.sum",
+ },
+ },
+ Object {
+ "file": Object {
+ "contents": "New go.mod",
+ "name": "go.mod",
+ },
+ },
+]
+`;
+
+exports[`.updateArtifacts() skips updating import paths for gopkg.in dependencies 2`] = `
+Array [
+ Object {
+ "cmd": "go get -d ./...",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go mod tidy",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go mod tidy",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+]
+`;
+
+exports[`.updateArtifacts() skips updating import paths with gomodUpdateImportPaths on v0 to v1 1`] = `
+Array [
+ Object {
+ "file": Object {
+ "contents": "New go.sum",
+ "name": "go.sum",
+ },
+ },
+ Object {
+ "file": Object {
+ "contents": "New go.mod",
+ "name": "go.mod",
+ },
+ },
+]
+`;
+
+exports[`.updateArtifacts() skips updating import paths with gomodUpdateImportPaths on v0 to v1 2`] = `
+Array [
+ Object {
+ "cmd": "go get -d ./...",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go mod tidy",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go mod tidy",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+]
+`;
+
exports[`.updateArtifacts() supports docker mode with credentials 1`] = `
Array [
Object {
@@ -349,3 +537,447 @@ Array [
},
]
`;
+
+exports[`.updateArtifacts() updates import paths with gomodUpdateImportPaths 1`] = `
+Array [
+ Object {
+ "file": Object {
+ "contents": "New go.sum",
+ "name": "go.sum",
+ },
+ },
+ Object {
+ "file": Object {
+ "contents": "New main.go",
+ "name": "main.go",
+ },
+ },
+ Object {
+ "file": Object {
+ "contents": "New go.mod",
+ "name": "go.mod",
+ },
+ },
+]
+`;
+
+exports[`.updateArtifacts() updates import paths with gomodUpdateImportPaths 2`] = `
+Array [
+ Object {
+ "cmd": "go get -d ./...",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go install github.com/marwan-at-work/mod/cmd/mod@latest",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "mod upgrade --mod-name=github.com/google/go-github/v24 -t=28",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go mod tidy",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go mod tidy",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+]
+`;
+
+exports[`.updateArtifacts() updates import paths with latest tool version on invalid version constraint 1`] = `
+Array [
+ Object {
+ "file": Object {
+ "contents": "New go.sum",
+ "name": "go.sum",
+ },
+ },
+ Object {
+ "file": Object {
+ "contents": "New main.go",
+ "name": "main.go",
+ },
+ },
+ Object {
+ "file": Object {
+ "contents": "New go.mod",
+ "name": "go.mod",
+ },
+ },
+]
+`;
+
+exports[`.updateArtifacts() updates import paths with latest tool version on invalid version constraint 2`] = `
+Array [
+ Object {
+ "cmd": "go get -d ./...",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go install github.com/marwan-at-work/mod/cmd/mod@latest",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "mod upgrade --mod-name=github.com/google/go-github/v24 -t=28",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go mod tidy",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go mod tidy",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+]
+`;
+
+exports[`.updateArtifacts() updates import paths with specific tool version from constraint 1`] = `
+Array [
+ Object {
+ "file": Object {
+ "contents": "New go.sum",
+ "name": "go.sum",
+ },
+ },
+ Object {
+ "file": Object {
+ "contents": "New main.go",
+ "name": "main.go",
+ },
+ },
+ Object {
+ "file": Object {
+ "contents": "New go.mod",
+ "name": "go.mod",
+ },
+ },
+]
+`;
+
+exports[`.updateArtifacts() updates import paths with specific tool version from constraint 2`] = `
+Array [
+ Object {
+ "cmd": "go get -d ./...",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go install github.com/marwan-at-work/mod/cmd/mod@v1.2.3",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "mod upgrade --mod-name=github.com/google/go-github/v24 -t=28",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go mod tidy",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+ Object {
+ "cmd": "go mod tidy",
+ "options": Object {
+ "cwd": "/tmp/github/some/repo",
+ "encoding": "utf-8",
+ "env": Object {
+ "CGO_ENABLED": "1",
+ "GONOPROXY": "noproxy.example.com/*",
+ "GONOSUMDB": "1",
+ "GOPATH": "/tmp/renovate/cache/others/go",
+ "GOPRIVATE": "private.example.com/*",
+ "GOPROXY": "proxy.example.com",
+ "HOME": "/home/user",
+ "HTTPS_PROXY": "https://example.com",
+ "HTTP_PROXY": "http://example.com",
+ "LANG": "en_US.UTF-8",
+ "LC_ALL": "en_US",
+ "NO_PROXY": "localhost",
+ "PATH": "/tmp/path",
+ },
+ "maxBuffer": 10485760,
+ "timeout": 900000,
+ },
+ },
+]
+`;
diff --git a/lib/manager/gomod/artifacts.spec.ts b/lib/manager/gomod/artifacts.spec.ts
index 4fe2b8e511ece6535715dde853963ee7d2fe21a5..0125d9f51968e70db6818ae98b975aa6d616032a 100644
--- a/lib/manager/gomod/artifacts.spec.ts
+++ b/lib/manager/gomod/artifacts.spec.ts
@@ -258,4 +258,138 @@ describe('.updateArtifacts()', () => {
).toMatchSnapshot();
expect(execSnapshots).toMatchSnapshot();
});
+ it('updates import paths with gomodUpdateImportPaths', async () => {
+ fs.readFile.mockResolvedValueOnce('Current go.sum' as any);
+ fs.readFile.mockResolvedValueOnce(null as any); // vendor modules filename
+ const execSnapshots = mockExecAll(exec);
+ git.getRepoStatus.mockResolvedValueOnce({
+ modified: ['go.sum', 'main.go'],
+ } as StatusResult);
+ fs.readFile
+ .mockResolvedValueOnce('New go.sum' as any)
+ .mockResolvedValueOnce('New main.go' as any)
+ .mockResolvedValueOnce('New go.mod' as any);
+ expect(
+ await gomod.updateArtifacts({
+ packageFileName: 'go.mod',
+ updatedDeps: ['github.com/google/go-github/v24'],
+ newPackageFileContent: gomod1,
+ config: {
+ ...config,
+ updateType: 'major',
+ newMajor: 28,
+ postUpdateOptions: ['gomodUpdateImportPaths'],
+ },
+ })
+ ).toMatchSnapshot();
+ expect(execSnapshots).toMatchSnapshot();
+ });
+ it('skips updating import paths with gomodUpdateImportPaths on v0 to v1', async () => {
+ fs.readFile.mockResolvedValueOnce('Current go.sum' as any);
+ fs.readFile.mockResolvedValueOnce(null as any); // vendor modules filename
+ const execSnapshots = mockExecAll(exec);
+ git.getRepoStatus.mockResolvedValueOnce({
+ modified: ['go.sum', 'main.go'],
+ } as StatusResult);
+ fs.readFile
+ .mockResolvedValueOnce('New go.sum' as any)
+ .mockResolvedValueOnce('New go.mod' as any);
+ expect(
+ await gomod.updateArtifacts({
+ packageFileName: 'go.mod',
+ updatedDeps: ['github.com/pkg/errors'],
+ newPackageFileContent: gomod1,
+ config: {
+ ...config,
+ updateType: 'major',
+ newMajor: 1,
+ postUpdateOptions: ['gomodUpdateImportPaths'],
+ },
+ })
+ ).toMatchSnapshot();
+ expect(execSnapshots).toMatchSnapshot();
+ });
+ it('updates import paths with specific tool version from constraint', async () => {
+ fs.readFile.mockResolvedValueOnce('Current go.sum' as any);
+ fs.readFile.mockResolvedValueOnce(null as any); // vendor modules filename
+ const execSnapshots = mockExecAll(exec);
+ git.getRepoStatus.mockResolvedValueOnce({
+ modified: ['go.sum', 'main.go'],
+ } as StatusResult);
+ fs.readFile
+ .mockResolvedValueOnce('New go.sum' as any)
+ .mockResolvedValueOnce('New main.go' as any)
+ .mockResolvedValueOnce('New go.mod' as any);
+ expect(
+ await gomod.updateArtifacts({
+ packageFileName: 'go.mod',
+ updatedDeps: ['github.com/google/go-github/v24'],
+ newPackageFileContent: gomod1,
+ config: {
+ ...config,
+ updateType: 'major',
+ newMajor: 28,
+ postUpdateOptions: ['gomodUpdateImportPaths'],
+ constraints: {
+ gomodMod: 'v1.2.3',
+ },
+ },
+ })
+ ).toMatchSnapshot();
+ expect(execSnapshots).toMatchSnapshot();
+ });
+ it('updates import paths with latest tool version on invalid version constraint', async () => {
+ fs.readFile.mockResolvedValueOnce('Current go.sum' as any);
+ fs.readFile.mockResolvedValueOnce(null as any); // vendor modules filename
+ const execSnapshots = mockExecAll(exec);
+ git.getRepoStatus.mockResolvedValueOnce({
+ modified: ['go.sum', 'main.go'],
+ } as StatusResult);
+ fs.readFile
+ .mockResolvedValueOnce('New go.sum' as any)
+ .mockResolvedValueOnce('New main.go' as any)
+ .mockResolvedValueOnce('New go.mod' as any);
+ expect(
+ await gomod.updateArtifacts({
+ packageFileName: 'go.mod',
+ updatedDeps: ['github.com/google/go-github/v24'],
+ newPackageFileContent: gomod1,
+ config: {
+ ...config,
+ updateType: 'major',
+ newMajor: 28,
+ postUpdateOptions: ['gomodUpdateImportPaths'],
+ constraints: {
+ gomodMod: 'a.b.c',
+ },
+ },
+ })
+ ).toMatchSnapshot();
+ expect(execSnapshots).toMatchSnapshot();
+ });
+ it('skips updating import paths for gopkg.in dependencies', async () => {
+ fs.readFile.mockResolvedValueOnce('Current go.sum' as any);
+ fs.readFile.mockResolvedValueOnce(null as any); // vendor modules filename
+ const execSnapshots = mockExecAll(exec);
+ git.getRepoStatus.mockResolvedValueOnce({
+ modified: ['go.sum'],
+ } as StatusResult);
+ fs.readFile
+ .mockResolvedValueOnce('New go.sum' as any)
+ .mockResolvedValueOnce('New go.mod' as any);
+ expect(
+ await gomod.updateArtifacts({
+ packageFileName: 'go.mod',
+ updatedDeps: ['gopkg.in/yaml.v2'],
+ newPackageFileContent: gomod1,
+ config: {
+ ...config,
+ updateType: 'major',
+ newMajor: 28,
+ postUpdateOptions: ['gomodUpdateImportPaths'],
+ },
+ })
+ ).toMatchSnapshot();
+ expect(execSnapshots).toMatchSnapshot();
+ });
});
diff --git a/lib/manager/gomod/artifacts.ts b/lib/manager/gomod/artifacts.ts
index a95a702eaeb2e54bc4822c5a0c6e1251707cc236..05aba78b982f957eaa65dcf08d53e1d853005fb4 100644
--- a/lib/manager/gomod/artifacts.ts
+++ b/lib/manager/gomod/artifacts.ts
@@ -8,7 +8,12 @@ import { BinarySource } from '../../util/exec/common';
import { ensureCacheDir, readLocalFile, writeLocalFile } from '../../util/fs';
import { getRepoStatus } from '../../util/git';
import { find } from '../../util/host-rules';
-import type { UpdateArtifact, UpdateArtifactsResult } from '../types';
+import { isValid } from '../../versioning/semver';
+import type {
+ UpdateArtifact,
+ UpdateArtifactsConfig,
+ UpdateArtifactsResult,
+} from '../types';
function getPreCommands(): string[] | null {
const credentials = find({
@@ -25,9 +30,47 @@ function getPreCommands(): string[] | null {
return preCommands;
}
+function getUpdateImportPathCmds(
+ updatedDeps: string[],
+ { constraints, newMajor }: UpdateArtifactsConfig
+): string[] {
+ const updateImportCommands = updatedDeps
+ .filter((x) => !x.startsWith('gopkg.in'))
+ .map((depName) => `mod upgrade --mod-name=${depName} -t=${newMajor}`);
+
+ if (updateImportCommands.length > 0) {
+ let installMarwanModArgs =
+ 'install github.com/marwan-at-work/mod/cmd/mod@latest';
+ const gomodModCompatibility = constraints?.gomodMod;
+ if (gomodModCompatibility) {
+ if (
+ gomodModCompatibility.startsWith('v') &&
+ isValid(gomodModCompatibility.replace(/^v/, ''))
+ ) {
+ installMarwanModArgs = installMarwanModArgs.replace(
+ /@latest$/,
+ `@${gomodModCompatibility}`
+ );
+ } else {
+ logger.debug(
+ { gomodModCompatibility },
+ 'marwan-at-work/mod compatibility range is not valid - skipping'
+ );
+ }
+ } else {
+ logger.debug(
+ 'No marwan-at-work/mod compatibility range found - installing marwan-at-work/mod latest'
+ );
+ }
+ updateImportCommands.unshift(`go ${installMarwanModArgs}`);
+ }
+
+ return updateImportCommands;
+}
+
export async function updateArtifacts({
packageFileName: goModFileName,
- updatedDeps: _updatedDeps,
+ updatedDeps,
newPackageFileContent: newGoModContent,
config,
}: UpdateArtifact): Promise<UpdateArtifactsResult[] | null> {
@@ -76,11 +119,31 @@ export async function updateArtifacts({
preCommands: getPreCommands(),
},
};
+
+ const execCommands = [];
+
let args = 'get -d ./...';
logger.debug({ cmd, args }, 'go get command included');
- const execCommands = [`${cmd} ${args}`];
+ execCommands.push(`${cmd} ${args}`);
+
+ // Update import paths on major updates above v1
+ const isImportPathUpdateRequired =
+ config.postUpdateOptions?.includes('gomodUpdateImportPaths') &&
+ config.updateType === 'major' &&
+ config.newMajor > 1;
+ if (isImportPathUpdateRequired) {
+ const updateImportCmds = getUpdateImportPathCmds(updatedDeps, config);
+ if (updateImportCmds.length > 0) {
+ logger.debug(updateImportCmds, 'update import path commands included');
+ // The updates
+ execCommands.push(...updateImportCmds);
+ }
+ }
- if (config.postUpdateOptions?.includes('gomodTidy')) {
+ const isGoModTidyRequired =
+ config.postUpdateOptions?.includes('gomodTidy') ||
+ config.updateType === 'major';
+ if (isGoModTidyRequired) {
args = 'mod tidy';
logger.debug({ cmd, args }, 'go mod tidy command included');
execCommands.push(`${cmd} ${args}`);
@@ -90,7 +153,7 @@ export async function updateArtifacts({
args = 'mod vendor';
logger.debug({ cmd, args }, 'go mod vendor command included');
execCommands.push(`${cmd} ${args}`);
- if (config.postUpdateOptions?.includes('gomodTidy')) {
+ if (isGoModTidyRequired) {
args = 'mod tidy';
logger.debug({ cmd, args }, 'go mod tidy command included');
execCommands.push(`${cmd} ${args}`);
@@ -98,7 +161,7 @@ export async function updateArtifacts({
}
// We tidy one more time as a solution for #6795
- if (config.postUpdateOptions?.includes('gomodTidy')) {
+ if (isGoModTidyRequired) {
args = 'mod tidy';
logger.debug({ cmd, args }, 'additional go mod tidy command included');
execCommands.push(`${cmd} ${args}`);
@@ -121,6 +184,21 @@ export async function updateArtifacts({
},
];
+ // Include all the .go file import changes
+ if (isImportPathUpdateRequired) {
+ logger.debug('Returning updated go source files for import path changes');
+ for (const f of status.modified) {
+ if (f.endsWith('.go')) {
+ res.push({
+ file: {
+ name: f,
+ contents: await readLocalFile(f),
+ },
+ });
+ }
+ }
+ }
+
if (useVendor) {
for (const f of status.modified.concat(status.not_added)) {
if (f.startsWith(vendorDir)) {
diff --git a/lib/manager/gomod/readme.md b/lib/manager/gomod/readme.md
index 8ffefa366d372597e93ae471db3e60154688991a..3df99e90e530d65c9b2f09d61d705924a53a7ddd 100644
--- a/lib/manager/gomod/readme.md
+++ b/lib/manager/gomod/readme.md
@@ -1 +1,5 @@
-You might be interested to add `"postUpdateOptions": ["gomodTidy"]` to your config if you'd like Renovate to run `go mod tidy` after every update before raising the PR.
+You might be interested in the following `postUpdateOptions`:
+
+1. `gomodTidy` - if you'd like Renovate to run `go mod tidy` after every update before raising the PR.
+ 1. This is implicitly enabled for major updates
+1. `gomodUpdateImportPaths` - if you'd like Renovate to update your source import paths on major updates before raising the PR.
diff --git a/lib/manager/types.ts b/lib/manager/types.ts
index 94ad3a8ed580179975826b975df95bd690471f21..1d8693d3fe51414dbb0d356cda6fdde876ce422d 100644
--- a/lib/manager/types.ts
+++ b/lib/manager/types.ts
@@ -50,6 +50,7 @@ export interface UpdateArtifactsConfig extends ManagerConfig {
updateType?: UpdateType;
newValue?: string;
newVersion?: string;
+ newMajor?: number;
}
export interface PackageUpdateConfig {