Skip to content

Commit 76c96cb

Browse files
authored
add info about semaphore and build kite support (#11)
add info about semaphore and build kite support
2 parents 7964840 + a74626f commit 76c96cb

File tree

3 files changed

+26
-0
lines changed

3 files changed

+26
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Expect more docs soon...
2929
1. [Getting started](getting-started.md)
3030
1. [How does it work?](how-does-it-work.md)
3131
1. [Configuration — codechecks.yml/json/ts/js](configuration.md)
32+
1. CLI options
3233
1. [Checks (plugins) development](developing-checks.md)
3334
1. Developing reusable checks
3435
1. Testing checks

configuration.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,8 @@ It's the same as YML config but written in JSON.
8181
If you want to execute arbitrary logic this is the way to go. The only thing you need to do is
8282
export async function from your module. We support es6 named export `main`, default export and
8383
commonjs export.
84+
85+
## CLI
86+
87+
- `--fail-fast` — stops running checks after the first failure, works only in local mode. CLI exits
88+
with non-zero code. This might be useful for executing codechecks in precommit hooks.

supported-ci.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,27 @@
22

33
- Circle CI
44
- Travis CI
5+
- BuildKite CI
6+
- Semaphore CI
57

68
Is your favorite CI provider missing? Just create an issue
79
[here](https://github.com/codechecks/monorepo). You can implement it on your own, read this
810
[quick guide](adding-new-ci.md)
11+
12+
## Semaphore CI Known issues
13+
14+
Note that passing secrets requires specifying
15+
16+
```
17+
secrets:
18+
- name: CC_SECRET
19+
```
20+
21+
in task description.
22+
23+
Unfortunately, at this time Semaphore using codechecks won't have access to detailed PR info (things
24+
like PR title or body information). It also requires
25+
[speculative-branch execution](https://github.com/codechecks/docs/blob/master/configuration.md#speculative-branch-execution)
26+
feature. So please configure branch priority if you use other branches than `master`.
27+
28+
In Semaphore CI settings remember to **turn off** CI execution on pull requests.

0 commit comments

Comments
 (0)