The tool can be installed via:
go get github.com/saschagrunert/go-modiff/cmd/go-modiff
After that, the application can be used like this:
> go-modiff -r github.com/cri-o/cri-o -f v1.15.0
INFO Setting up repository github.com/cri-o/cri-o
INFO Retrieving modules of v1.15.0
INFO Retrieving modules of master
INFO 385 modules found
INFO 1 modules added
INFO 11 modules changed
INFO 0 modules removed
INFO Done, the result will be printed to `stdout`
# Dependencies
## Added
- github.com/creack/pty: v1.1.7
## Changed
- github.com/containerd/go-runc: 7d11b49 β 9007c24
- github.com/containerd/project: 831961d β 7fb81da
- github.com/containerd/ttrpc: 2a805f7 β 1fb3814
- github.com/containers/libpod: 5e42bf0 β v1.4.4
- github.com/containers/storage: v1.12.12 β v1.12.13
- github.com/godbus/dbus: 2ff6f7f β 8a16820
- github.com/kr/pty: v1.1.5 β v1.1.8
- golang.org/x/net: 3b0461e β da137c7
- golang.org/x/sys: c5567b4 β 04f50cd
- google.golang.org/grpc: v1.21.1 β v1.22.0
- honnef.co/go/tools: e561f67 β ea95bdf
## Removed
_Nothing has changed._
It is also possible to add diff links to the markdown output via --link, -l
.
The output would then look like this:
# Dependencies
## Added
- github.com/shurcooL/httpfs: [8d4bc4b](https://github.com/shurcooL/httpfs/tree/8d4bc4b)
- github.com/shurcooL/vfsgen: [6a9ea43](https://github.com/shurcooL/vfsgen/tree/6a9ea43)
## Changed
- github.com/onsi/ginkgo: [v1.8.0 β v1.9.0](https://github.com/onsi/ginkgo/compare/v1.8.0...v1.9.0)
- github.com/onsi/gomega: [v1.5.0 β v1.6.0](https://github.com/onsi/gomega/compare/v1.5.0...v1.6.0)
- github.com/saschagrunert/ccli: [e981d95 β 05e6f25](https://github.com/saschagrunert/ccli/compare/e981d95...05e6f25)
- github.com/urfave/cli: [v1.20.0 β 23c8303](https://github.com/urfave/cli/compare/v1.20.0...23c8303)
## Removed
- github.com/saschagrunert/go-docgen: [v0.1.3](https://github.com/saschagrunert/go-docgen/tree/v0.1.3)
The following command line arguments are currently supported:
Argument | Description |
---|---|
--repository, -r |
repository to be used, like: github.com/owner/repo |
--from, -f |
the start of the comparison (any valid git rev) (default: "master") |
--to, -t |
the end of the comparison (any valid git rev) (default: "master") |
--link, -l |
add diff lnks to the markdown output (default: false) |
--debug, -d |
enable debug output (default: false) |
You want to contribute to this project? Wow, thanks! So please just fork it and send me a pull request.