octoleo/gh-ost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4e6e454abd
gh-ost/doc/coding-ghost.md
Jess Breckenridge 7df2e0d433 - Updating PR template to reflect current build workflow
2017-05-04 12:51:00 -06:00

751 B
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.

Notes:

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