gorepomod

README

gorepomod

Helps when you have a git repository with multiple Go modules.

It handles tasks one might otherwise attempt with

find ./ -name "go.mod" | xargs {some hack}

Run it from a git repository root.

It walks the repository, reads go.mod files, builds a model of Go modules and intra-repo module dependencies, then performs some operation.

Install:

go get sigs.k8s.io/kustomize/cmd/gorepomod

Usage

Commands that change things (everything but list) do nothing but log commands unless you add the --doIt flag, allowing the change.

If you want to run gorepomod on your fork or outside of $GOSRC directory, add --local flag to your command.

gorepomod list

Lists modules and intra-repo dependencies.

Use this to get module names for use in other commands.

gorepomod tidy

Creates a change with mechanical updates to go.mod and go.sum files.

gorepomod unpin {module} [{conditionalmodule}]

Creates a change to go.mod files.

For each module m in the repository, if m depends on a {module}, then m's dependency on _{module} will be replaced by a relative path to the in-repo version of {module}.

If conditionalModule is specified, then the replacement of {module} will happen if m depends on {conditionalModule}.

gorepomod pin {module} [{version}]

Creates a change to go.mod files.

The opposite of unpin.

The change removes replacements and pins m to a specific, previously tagged and released version of {module}.

The argument {version} defaults to recent version of {module}.

{version} should be in semver form, e.g. v1.2.3.

gorepomod release {module} [patch|minor|major]

Computes a new version for the module, tags the repo with that version, and pushes the tag to the remote.

The value of the 2nd argument, either patch (the default), minor or major, determines the new version.

If the existing version is v1.2.7, then the new version will be:

• patch -> v1.2.8
• minor -> v1.3.0
• major -> v2.0.0

After establishing the version, the command looks for a branch named

release-{module}/-v{major}.{minor}

If the branch doesn't exist, the command creates it and pushes it to the remote.

The command then creates a new tag in the form

{module}/v{major}.{minor}.{patch}

The command pushes this tag to the remote. This typically triggers cloud activity to create release artifacts.

gorepomod unrelease {module}

This undoes the work of release, by deleting the most recent tag both locally and at the remote.

You can then fix whatever, and re-release.

This, however, must be done almost immediately.

If there's a chance someone (or some cloud robot) already imported the module at the given tag, then don't do this, because it will confuse module caches.

Do a new patch release instead.

Documentation

Overview

Code generated by internal/gen/main.go; DO NOT EDIT.