Script to elegantly update direct Go modules in separate commits.
Automatically updates dependencies similar to go get -u, but commits the update to each direct
module in a separate commit.
mkdir -p ~/bin
curl https://raw.githubusercontent.com/xorcare/go-mod-bump/main/go-mod-bump.sh --output ~/bin/go-mod-bump
chmod +x ~/bin/go-mod-bumpAfter that don't forget to add the ~/bin directory to the $PATH variable.
Use one of the following commands to do this:
echo 'export PATH="$PATH:$HOME/bin"' >> ~/.bashrc
# Or
echo 'export PATH="$PATH:$HOME/bin"' >> ~/.zshrcIf you know a better way use it or let me know I will update the documentation.
For update all direct models, use:
go-mod-bump allFor update one specific direct module, specify its name. For example:
go-mod-bump github.com/xorcare/pointerFor update multiple direct modules, specify their names. For example:
go-mod-bump github.com/xorcare/pointer github.com/xorcare/tornadoAlso, you can add custom prefix for git message. For example:
go-mod-bump -p 'build(deps): ' allGit log with message prefix example
build(deps): Bump github.com/xorcare/pointer from v1.0.0 to v1.1.1
build(deps): Bump github.com/xorcare/tornado from v0.1.0 to v0.1.1
build(deps): Bump github.com/xorcare/golden from v0.6.0 to v0.8.2
- The script does not know how to work with
replacedirective, if it is used in your project be careful and do not forget to update dependencies manually. - Pipelines are not supported, you cannot use go-mod-bump in combination with
|. - The script runs very slowly on projects with a lot of dependencies.
- The script does not abort execution if a module fails to update. It will try to update other modules if possible.
When using this script, you should be aware that it propagates changes to the Git history. In some cases, you may lose all your uncommitted changes forever.
Log with all modules updated successfully
go-mod-bump: upgraded github.com/xorcare/pointer v1.0.0 => [v1.1.1]
go-mod-bump: upgraded github.com/xorcare/tornado v0.1.0 => [v0.1.1]
go-mod-bump: upgraded github.com/xorcare/golden v0.6.0 => [v0.8.2]
go-mod-bump: upgraded golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550 => [v0.18.0]
go-mod-bump: upgraded golang.org/x/lint v0.0.0-20200302205851-738671d3881b =>
[v0.0.0-20210508222113-6edffad5e616]
Log with on module update failed
go-mod-bump: failed to update module github.com/xorcare/golden
v0.0.0-20180918085934-3c96afc26e10 to v0.0.0-20200320164324-52e96869b7ff
try to update module manually using commands:
go get github.com/xorcare/[email protected]
go mod tidy
go build ./...
go-mod-bump: upgraded github.com/xorcare/tornado v0.1.0 => [v0.1.1]
go-mod-bump: upgraded github.com/xorcare/pointer v1.0.0 => [v1.1.1]
Git log example
Bump github.com/xorcare/pointer from v1.0.0 to v1.1.1
Bump github.com/xorcare/tornado from v0.1.0 to v0.1.1
Bump github.com/xorcare/golden from v0.6.0 to v0.8.2
Bump golang.org/x/crypto from v0.0.0-20191011191535-87dc89f01550 to v0.18.0
Bump golang.org/x/lint from v0.0.0-20200302205851-738671d3881b to
v0.0.0-20210508222113-6edffad5e616