-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[wpengine/golang] Update golang image README
- Loading branch information
Showing
1 changed file
with
52 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,70 @@ | ||
# golang | ||
|
||
Golang base image with additional packages to assist in running unit tests. | ||
Golang base image with additional tools for development. | ||
|
||
## Versions | ||
|
||
This image is versioned by the following tagging scheme to support existing applications: | ||
``` | ||
wpengine/golang:<major-golang-version>-wpe<toolset-version> | ||
``` | ||
where `<major-golang-version>` might be Go version `1.12` and `<toolset-version>` would be an integer that is incremented (independently of the major Golang version) when any bundled tools are modified in a non-backwards-compatible fashion. This enables major golang versions to be updated, while preserving the versioning of our tooling dependencies. | ||
|
||
## Usage | ||
|
||
As a linter: | ||
Lint files: | ||
``` | ||
docker run --rm \ | ||
-v $(pwd):/go/src/${package_name} \ | ||
-w /go/src/${package_name} \ | ||
wpengine/golang | ||
golangci-lint run --no-config --issues-exit-code=0 --disable-all --enable=vet --enable=golint --enable=gofmt | ||
``` | ||
|
||
With gometalinter (deprecated 04/07/19): | ||
Run unit tests: | ||
``` | ||
docker run --rm \ | ||
-v $(pwd):/go/src/${package_name} \ | ||
-w /go/src/${package_name} \ | ||
wpengine/golang gometalinter --vendor --disable-all --enable=golint --enable=vet --enable=gofmt ./... | ||
-v $(pwd):/go/src/${package_name} \ | ||
wpengine/golang | ||
bash -c "gocov test ./... | gocov report" | ||
``` | ||
|
||
With golangci-lint: | ||
Run unit tests with coverage: | ||
``` | ||
docker run --rm -v \ | ||
-v $(pwd):/go/src/${package_name} \ | ||
-w /go/src/${package_name} \ | ||
wpengine/golang golangci-lint run --no-config --issues-exit-code=0 \ | ||
--disable-all --enable=vet --enable=golint --enable=gofmt | ||
mkdir -p ./artifacts/ | ||
docker run --rm --volume `pwd`/artifacts:/go/src/$(package_name)/artifacts wpengine/golang \ | ||
bash -c "go test ./... -coverprofile=artifacts/coverage.out -v 2>&1 | tee artifacts/test-results.out" | ||
docker run --rm --volume `pwd`/artifacts:/go/src/$(package_name)/artifacts wpengine/golang \ | ||
bash -c "cat artifacts/test-results.out | go-junit-report -set-exit-code > artifacts/junit.xml" | ||
docker run --rm --volume `pwd`/artifacts:/go/src/$(package_name)/artifacts wpengine/golang \ | ||
bash -c "gocov convert ./artifacts/coverage.out | gocov-xml > ./artifacts/coverage.xml" | ||
``` | ||
|
||
Run unit tests: | ||
Install dependencies: | ||
``` | ||
docker run --rm -v \ | ||
$(pwd):/go/src/${package_name} \ | ||
wpengine/golang /bin/bash unit_tests.sh -p ${package_name} | ||
docker run --rm \ | ||
-v $(pwd):/go/src/${package_name} \ | ||
-w /go/src/${package_name} \ | ||
wpengine/golang | ||
bash -c "git config --global url.'https://$(GITHUB_TOKEN):[email protected]/'.insteadOf 'https://github.com/' \ | ||
&& go mod vendor" | ||
``` | ||
|
||
Installing dependencies: | ||
## Changelog | ||
This changelog describes changes made specifically to the `<toolset-version>` described above. | ||
|
||
### \<version\>-wpe0 | ||
This version contains `protobuf-compiler` and the following Go tools: | ||
``` | ||
docker run --rm -v \ | ||
$(pwd):/go/src/${package_name} \ | ||
-w /go/src/${package_name} \ | ||
wpengine/golang glide install -v | ||
github.com/golang/protobuf/proto | ||
github.com/golang/protobuf/protoc-gen-go | ||
google.golang.org/grpc | ||
github.com/alecthomas/gometalinter | ||
github.com/Masterminds/glide | ||
github.com/golang/dep/cmd/dep | ||
github.com/jstemmer/go-junit-report | ||
github.com/axw/gocov/gocov | ||
github.com/AlekSi/gocov-xml | ||
github.com/golangci/golangci-lint/cmd/golangci-lint | ||
``` |