20 lines
751 B
Markdown
20 lines
751 B
Markdown
# 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.
|