deppy

README

Deppy

Command deppy helps build packages reproducibly by fixing their dependencies.

This tool assumes you are working in a standard Go workspace, as described in http://golang.org/doc/code.html. We require Go 1.1 or newer to build deppy itself, but you can use it on any project that works with Go 1 or newer.

Install

go get github.com/hamfist/deppy

Migrating from godep

git mv Godep Deps

Getting Started

How to add deppy in a new project.

Assuming you've got everything working already, so you can build your project with go install and test it with go test, it's one command to start using:

deppy save

This will save a list of dependencies to the file Deps, Read over its contents and make sure it looks reasonable. Then commit the file to version control.

Restore

The deppy restore command is the opposite of deppy save. It will install the package versions specified in Deps to your $GOPATH.

Edit-test Cycle

1. Edit code
2. Run deppy go test
3. (repeat)

Add a Dependency

To add a new package foo/bar, do this:

1. Run go get foo/bar
2. Edit your code to import foo/bar.
3. Run deppy save (or deppy save ./...).

Update a Dependency

To update a package from your $GOPATH, do this:

1. Run go get -u foo/bar
2. Run deppy save (or deppy save ./...).

Before committing the change, you'll probably want to inspect the changes to Deps, for example with git diff, and make sure it looks reasonable.

Multiple Packages

If your repository has more than one package, you're probably accustomed to running commands like go test ./..., go install ./..., and go fmt ./.... Similarly, you should run deppy save ./... to capture the dependencies of all packages.

Using Other Tools

The deppy path command helps integrate with commands other than the standard go tool. This works with any tool that reads $GOPATH from its environment, for example the recently-released oracle command.

GOPATH=`deppy path`:$GOPATH
oracle -mode=implements .

File Format

Deps is a json file with the following structure:

type Deps struct {
	ImportPath string
	GoVersion  string   // Abridged output of 'go version'.
	Packages   []string // Arguments to deppy save, if any.
	Deps       []struct {
		ImportPath string
		Comment    string // Description of commit, if present.
		Rev        string // VCS-specific commit ID.
	}
}

Example Deps:

{
    "ImportPath": "github.com/kr/hk",
    "GoVersion": "go1.3.2",
    "Deps": [
        {
            "ImportPath": "code.google.com/p/go-netrc/netrc",
            "Rev": "28676070ab99"
        },
        {
            "ImportPath": "github.com/kr/binarydist",
            "Rev": "3380ade90f8b0dfa3e363fd7d7e941fa857d0d13"
        }
    ]
}

Plagiarism Alert

Deppy is a fork of Godep, and makes no attempt to hide it. Take a look at the repo history. It's all there. The code fork is a reflection of the philosophical fork that happened in the Godep project when save -copy=false was deprecated and slated for removal. Deppy chooses the other path, making save -copy=false the default behavior and save -copy=true into a no-op.

Documentation

Overview

Command deppy helps build packages reproducibly by fixing their dependencies.

Example Usage

Save currently-used dependencies to file Deps:

$ deppy save

Build project using saved dependencies:

$ deppy go install

or

$ GOPATH=`deppy path`:$GOPATH
$ go install