development.md

Development Guide

Prerequisite

• git

• go version v1.12+

• Linting Tools

  linting tool	version
  hadolint	v1.17.2
  shellcheck	v0.7.0
  yamllint	v1.17.0
  helm client	v2.10.0
  golangci-lint	v1.18.0
  autopep8	v1.4.4
  mdl	v0.5.0
  awesome_bot	1.19.1
  sass-lint	v1.13.1
  tslint	v5.18.0
  prototool	7df3b95
  goimports	3792095

Developer quick start

• Setup GIT_HOST to override the setting for your custom path.

export GIT_HOST=github.com/<YOUR_GITHUB_ID>

• Run the linter and test before building the binary.

make check
make test
make build

• Build and push the docker image for local development.

export IMG=<YOUR_CUSTOMIZED_IMAGE_NAME>
export REGISTRY=<YOUR_CUSTOMIZED_IMAGE_REGISTRY>
make build-push-images

Note: You need to login the docker registry before running the command above.