containerd/hack/repo-infra/verify
Mike Brown 07ad470bde Merge commit '031b284c8a15ad4b28f81b113a9f2018af5b1da6' as 'hack/repro-infra'
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2017-04-21 12:17:40 -05:00
..
boilerplate Merge commit '031b284c8a15ad4b28f81b113a9f2018af5b1da6' as 'hack/repro-infra' 2017-04-21 12:17:40 -05:00
go-tools Merge commit '031b284c8a15ad4b28f81b113a9f2018af5b1da6' as 'hack/repro-infra' 2017-04-21 12:17:40 -05:00
README.md Merge commit '031b284c8a15ad4b28f81b113a9f2018af5b1da6' as 'hack/repro-infra' 2017-04-21 12:17:40 -05:00
verify-boilerplate.sh Merge commit '031b284c8a15ad4b28f81b113a9f2018af5b1da6' as 'hack/repro-infra' 2017-04-21 12:17:40 -05:00
verify-go-src.sh Merge commit '031b284c8a15ad4b28f81b113a9f2018af5b1da6' as 'hack/repro-infra' 2017-04-21 12:17:40 -05:00

Verification scripts

Collection of scripts that verifies that a project meets requirements set for kubernetes related projects. The scripts are to be invoked depending on the needs via CI tooling, such as Travis CI. See main Readme file on how to integrate the repo-infra in your project.

The scripts are currently being migrated from the main kubernetes repository. If your project requires additional set of verifications, consider creating an issue/PR on repo-infra to avoid code duplication across multiple projects.

If repo-infra is integrated at the root of your project as git submodule at path: /repo-infra, then scripts can be invoked as repo-infra/verify/verify-*.sh

travis.yaml example:

dist: trusty

os:
- linux

language: go

go:
- 1.8

before_install:
- go get -u github.com/alecthomas/gometalinter

install:
- gometalinter --install

script:
- repo-infra/verify/verify-go-src.sh -v
- repo-infra/verify/verify-boilerplate.sh
# OR with vendoring 
# - vendor/github.com/kubernetes/repo-infra/verify-go-src.sh --rootdir=$(pwd) -v

Verify boilerplate

Verifies that the boilerplate for various formats (go files, Makefile, etc.) is included in each file: verify-boilerplate.sh.

Verify go source code

Runs a set of scripts on the go source code excluding vendored files: verify-go-src.sh. Expects gometalinter tooling installed (see travis file above)

With git submodule from your repo root: repo-infra/verify/verify-go-src.sh -v

With vendoring: vendor/repo-infra/verify/verify-go-src.sh -v --rootdir $(pwd)

Checks include:

  1. gofmt
  2. gometalinter
  3. govet