gapp

This project is still a work in progress. Don't use it yet.

VGO

Lightweight unassuming application vendoring for your go projects. VGO decorates the default behaviour of the Go command to ensure you have reproducable builds for your projects. The intention is to be compatible with the default options of the go command line tools by setting up your project with a vendor directory containing all the dependencies of your project and storing the specific commit hashes of each dependency so builds can reproduced.

The only real requirement is that your GO15VENDOREXPERIMENT environment variable is set to 1. As of Go#1.6 this will be the default setting.

Version tags (e.g. 1.4 or v1.4) are matched according to SemVer rules.

Install

You will need to have your $GOPATH/bin directory available in your $PATH for this method.

go install github.com/whitecypher/vgo

Usage

Default

Installs the dependencies listed in the manifest at the designated reference point. If no manifest exists, use vgo discover to resolve dependencies and create one. Where no reference point is available in the manifest the last reference compatible with the required version, branch, tag, or commit will be installed. The installed reference point will be stored in the manifest unless otherwise suppressed using the --dry option.

When the --dry option is present, the resulting YAML is printed to the terminal.

vgo [--dry]

Discover

Scans your project to create/update a manifest of all automatically resolved dependencies. Dependencies not yet added will be added, and packages no longer in use remain untouched until specifically removed using the vgo remove command. Changes are stored in the vgo manifest file unless executed with the --dry option.

vgo [--dry] discover

Get

Get a dependency compatible with the optionally specified version, branch, tag, or commit. If the current installed reference is not compatible with the required version, branch, tag, or commit it will be updated and the new reference stored in the dependency manifest. This done to ensure manual changes to the manifest will be adhered to when compatibility is compromised. If current reference is compatible (an earlier reference point of the master branch for example) then the stored reference point will be used and the -u flag will must be added. When the -u flag is provided a dependency will be updated to the latest reference compatible with the stored version, branch, tag, or commit. If a {packagename} with a [#{version|branch|tag|commit}] is given, and differs from that stored in the manifest, the -u option is implied.

vgo get [-u] ./...
#or
vgo get [-u] {packagename}[#{version}]
#or
vgo get [-u] {packagename}[#{branch}]
#or
vgo get [-u] {packagename}[#{tag}]
#or
vgo get [-u] {packagename}[#{commit}]

e.g. vgo get github.com/codegangsta/cli#v1.4.1 or vgo get github.com/codegangsta/cli#v1.4 or vgo get github.com/codegangsta/cli#v1

Remove

Remove a dependency

vgo remove {packagename}
#or
vgo rm {packagename}

e.g. vgo remove github.com/codegangsta/cli

Main Add

The project root is scanned by default for .go files to build the dependency tree. When one or more main (entrypoint) packages are present in a project these need to be declared using the vgo main add command. These will be stored in the manifest and scanned each time vgo discover is executed.

vgo main add rel/path/to/main/pkg

Main Remove

Removes a main (entrypoint) package from the manifest preventing it from being included during dependency discovery.

vgo main remove rel/path/to/main/pkg
#or
vgo main rm rel/path/to/main/pkg

Catchall

Unmatched actions should fall through to go command automatically. This means that vgo run will automatically trigger go run with all the same rules and options available to you as the standard go commands. Vgo will run a sync action before deferring to the default go behavior to ensure the action is run on dependable codebase.

vgo ...

Mindset

• easy to use in an idiomatic go manner
• resolve the dependency diamond problem
• flexible to allow multiple (if not all) use cases