octoleo/gh-ost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b06c1cd498
gh-ost/doc/coding-ghost.md
Tim Vaillancourt 84dca03311
Add script and docs for linter (#1151)
2022-07-18 18:21:32 +02:00

1.2 KiB
Raw Blame History

Getting started with gh-ost development.

Overview

Getting started with gh-ost development is simple!

  • First obtain the repository with git clone or go get.
  • From inside of the repository run script/cibuild.
  • This will bootstrap the environment if needed, format the code, build the code, and then run the unit test.

CI build workflow

script/cibuild performs the following actions will bootstrap the environment to build gh-ost correctly, build, perform syntax checks and run unit tests.

If additional steps are needed, please add them into this workflow so that the workflow remains simple.

golang-ci linter

To enfore best-practices, Pull Requests are automatically linted by golang-ci. The linter config is located at .golangci.yml and the golangci-lint GitHub Action is located at .github/workflows/golangci-lint.yml.

To run the golang-ci linters locally (recommended before push), use script/lint.

Notes:

Currently, script/ensure-go-installed will install go for Mac OS X and Linux. We welcome PR's to add other platforms.