Automated Semantic Import Versioning Upgrades
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd/mod implicit client flag Jan 14, 2019
example Init Aug 26, 2018
major implicit client flag Jan 14, 2019
migrate implicit client flag Jan 14, 2019
README.md add go modules flag to installation instructions Dec 13, 2018
go.mod remove debug Aug 30, 2018
go.sum add migrate-community Aug 30, 2018
mod.go add migrate-community Aug 30, 2018

README.md

Mod

Command line tool to upgrade/downgrade Semantic Import Versioning in Go Modules

Motivation

There are two good use cases to do this:

  1. If you own a library and you want to introduce a breaking change, then you have to go around all your Go files and sub-pacakges and update the import paths to include v2, v3, etc. This tool just does it automatically with one command.

  2. If you own a library that is already tagged v2 or above but is incompatible with Semantic Import Versioning, then this tool can solve the problem for you with one command as well. Introduce a go.mod file with the correct import path, and just run mod upgrade once or mod -t=X upgrade (where x is the latest tag major) to update the import paths of your go files to match whatever tag you're at.

Install

GO111MODULE=on go get github.com/marwan-at-work/mod/cmd/mod

Usage

mod upgrade OR mod downgrade from any directory that has go.mod file.

The tool will update the major version in the go.mod file and it will traverse all the Go Files and upgrades/downgrades any imports as well.

For example, if you have the following package:

// go.mod

module github.com/me/example

require github.com/pkg/errors v0.8.0

that imports a sub directory in its Go files:

// example.go

package example

import (
    "github.com/me/example/subdir"
)

// rest of file...

You can run mod upgrade from the root of that directory and the above two files will be rewritten as such:

module github.com/me/example/v2

require github.com/pkg/errors
package example

import (
    "github.come/me/example/v2/subdir"
)

// rest of file...

You can of course, downgrade again or upgrade more incrementally.

You can also run this command inside the example folder and notice how the import paths and the module name alike get updated.

Status

Works as intended. Feel free to report any issues.