goup

command module
v0.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 23, 2024 License: MIT Imports: 12 Imported by: 0

README

Go Up

GoDoc Build Status Code Coverage Go Report Card

goup checks if there are any updates for imports in your module. It parses go.mod files to get dependencies with their version, uses go-git to retrieve the list of remote tags and performs comparisons to advise to update if necessary. The main purpose is using it as a linter in continuous integration or in development process, but you can also use it to keep updated the go.mod files, see the -f option.

Features

  1. No dependency. Pure Go tool designed to be used as a linter. Zero call to go or git command line tools.
  2. As go.mod uses the semantic versioning for module version, goup does the same and provides 3 modes: major, major+minor and by default, path.
  3. Takes care of each part of a mod file: require, exclude and replace.
  4. Allows the capacity to force some modules to only use release tag, no prerelease.
  5. Manages one or more go.mod files, for example with ./... as parameter.
  6. As with go1.14, you can use the GOINSECURE environment variable to skip certificate validation and do not require an HTTPS connection. Since version v0.3.0, GOPRIVATE has the same behavior.
  7. Can amend on demand go.mod files with deprecated dependencies to update them.
  8. Since version v0.4.0, a colorized output in a TTY.
  9. Allows to fetch Go modules from private repositories using ~/.netrc file or NETRC environment variable (https://go.dev/doc/faq#git_https).

Demo

$ goup -v -m ./...
$ goup: github.com/rvflash/goup: golang.org/x/mod v0.2.1-0.20200121190230-accd165b1659 is up to date
$ goup: github.com/rvflash/goup: github.com/matryer/is v1.1.0 must be updated with v1.2.0
$ goup: github.com/rvflash/goup: github.com/golang/mock v1.4.0 is up to date
$ goup: github.com/rvflash/goup: gopkg.in/src-d/go-git.v4 v4.13.1 is up to date

Installation

It's important to have reproducible CI, so it's recommended to install a specific version of goup available on the releases page.

Go
GO111MODULE=on go get github.com/rvflash/goup@v0.4.3
Docker
docker run --rm -v $(pwd):/pkg rvflash/goup:latest goup -V

Usage

goup [flags] [modfiles]

The goup command checks updates of any dependencies in the go.mod file. It supports the following flags:

  • -M: ensures to have the latest major version. By default, only the path is challenged.
  • -m: ensures to have the latest couple major with minor version. By default, only the path is challenged.
  • -V: prints the version of the tool.
  • -f: force the update of the go.mod file as advised
  • -i: allows excluding indirect modules.
  • -r: it's a comma-separated list of glob patterns to match the repository paths where to force tag usage. For example with github.com/group/* as value, any modules in this repository group must have a release tag, no prerelease.
  • -s: forces the process to exit on first error occurred.
  • -t: defines the maximum time duration to perform the check. By default, 10s.
  • -v: verbose output

[modfiles] can be one or more direct path to go.mod files, . or ./... to get all those in the tree.

Using example with an auto-signed local git repository:

GOINSECURE="gitlab.example.lan/*/*" goup -v .

Documentation

Overview

Package main provides the Go Up command line tool.

Source Files

View all Source files

Directories

Path Synopsis
internal
app
Package app manages the GoUp app.
 Package app manages the GoUp app.
errors
Package errors exposes the errors used by the GoUp app.
 Package errors exposes the errors used by the GoUp app.
log
Package log exposes the interface to implement as logger and provides some implementations.
 Package log exposes the interface to implement as logger and provides some implementations.
netrc
Package netrc provides methods to handle basic authentification used by the auto-login process in .netrc f.
 Package netrc provides methods to handle basic authentification used by the auto-login process in .netrc f.
path
Package path provides methods to check if a path matches some glob patterns.
 Package path provides methods to check if a path matches some glob patterns.
semver
Package semver implements comparison of semantic version strings.
 Package semver implements comparison of semantic version strings.
signal
Package signal provides methods to listen OS signal and attaches them to context.
 Package signal provides methods to listen OS signal and attaches them to context.
vcs
Package vcs exposes interfaces and methods implemented by a VCS.
 Package vcs exposes interfaces and methods implemented by a VCS.
vcs/git
Package git provides methods to handle Git.
 Package git provides methods to handle Git.
vcs/goget
Package goget provides methods to deal with go get as VCS.
 Package goget provides methods to deal with go get as VCS.
pkg
goup
Package goup provides methods to check updates on go.mod file and modules.
 Package goup provides methods to check updates on go.mod file and modules.
mod
Package mod exposes methods to parse a go.mod file.
 Package mod exposes methods to parse a go.mod file.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.