Skip to content

Commit 7df2e0d

Browse files
- Updating PR template to reflect current build workflow
1 parent 13491a0 commit 7df2e0d

2 files changed

Lines changed: 4 additions & 9 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,4 @@ This PR [briefly explain what is does]
1616
> In case this PR introduced Go code changes:
1717
1818
- [ ] contributed code is using same conventions as original code
19-
- [ ] code is formatted via `gofmt` (please avoid `goimports`)
20-
- [ ] code is built via `./build.sh`
21-
- [ ] code is tested via `./test.sh`
19+
- [ ] `script/cibuild` returns with no formatting errors, build errors or unit test errors.

doc/coding-ghost.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,15 @@
44

55
Getting started with gh-ost development is simple!
66

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

1111
## CI build workflow
1212

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

15-
- It runs `script/bootstrap`
16-
- `script/bootstrap` runs `script/ensure-go-installed`
17-
- `script/ensure-go-installed` installs go locally if (go is not installed) || (go is not version 1.7). It will not install go if it is already installed locally and at the correct version.
18-
- `script/build` builds the `gh-ost` binary and places in in `bin/`
15+
If additional steps are needed, please add them into this workflow so that the workflow remains simple.
1916

2017
## Notes:
2118

0 commit comments

Comments
 (0)