File tree 3 files changed +26
-0
lines changed
3 files changed +26
-0
lines changed Original file line number Diff line number Diff line change @@ -29,6 +29,7 @@ Expect more docs soon...
29
29
1 . [ Getting started] ( getting-started.md )
30
30
1 . [ How does it work?] ( how-does-it-work.md )
31
31
1 . [ Configuration — codechecks.yml/json/ts/js] ( configuration.md )
32
+ 1 . CLI options
32
33
1 . [ Checks (plugins) development] ( developing-checks.md )
33
34
1 . Developing reusable checks
34
35
1 . Testing checks
Original file line number Diff line number Diff line change @@ -81,3 +81,8 @@ It's the same as YML config but written in JSON.
81
81
If you want to execute arbitrary logic this is the way to go. The only thing you need to do is
82
82
export async function from your module. We support es6 named export `main`, default export and
83
83
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.
Original file line number Diff line number Diff line change 2
2
3
3
- Circle CI
4
4
- Travis CI
5
+ - BuildKite CI
6
+ - Semaphore CI
5
7
6
8
Is your favorite CI provider missing? Just create an issue
7
9
[ here] ( https://github.com/codechecks/monorepo ) . You can implement it on your own, read this
8
10
[ 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.
You can’t perform that action at this time.
0 commit comments