wedeploycli

README

WeDeploy CLI tool

Install this tool with

curl http://cdn.wedeploy.com/cli/latest/wedeploy.sh -sL | bash

or download from our stable release channel.

To update this tool, just run we update.

Dependencies

The following external soft dependencies are necessary to correctly run some commands:

• docker
• git

The availability of dependencies are tested just before its immediate use. If a required dependency is not found, an useful error message is printed and the calling process is terminated with an error code.

Contributing

You can get the latest CLI source code with go get -u github.com/wedeploy/cli

The following commands are available and requires no arguments:

• make get-dependencies: get versioned Go dependencies
• make list-packages: list all Go packages of the project
• make build
• make test: run all tests
• make release: tag, build, and publish new version of the app
• make promote: publish version already released to a given distribution channel

Important: always install dependencies by running make get-dependencies to make sure the current dependency versioning constraints apply.

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Integration tests should be written as well.

The master branch of this repository on GitHub is protected:

• force-push is disabled
• tests MUST pass on Travis before merging changes to master
• branches MUST be up to date with master before merging

Keep your commits neat. Try to always rebase your changes before publishing them.

goreportcard can be used online or locally to detect defects and static analysis results from tools such as go vet, go lint, gocyclo, and more.

Using go test and go cover are essential to make sure your code is covered with unit tests.

Some commands and aliases you might find useful for development / testing:

• Generating test coverage for the current directory: alias gotest='go test -coverprofile=coverage.out && go tool cover -html coverage.out -o coverage.html'
• Running code without building: alias i="go run $HOME/projects/gocode/src/github.com/wedeploy/cli/main.go $1" (i: development code, we: production binary)
• Opening coverage report: alias goreport="open coverage.html"
• alias golintt='test -z "$(golint ./... | grep -v "^vendor" | tee /dev/stderr)"'
• alias govet='go vet $(go list ./... | grep -v /vendor/)'