Skip to content

Commit c4f7e24

Browse files
committed
add docs about github actions
1 parent 76c96cb commit c4f7e24

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

supported-ci.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,43 @@
22

33
- Circle CI
44
- Travis CI
5+
- Github Actions
56
- BuildKite CI
67
- Semaphore CI
78

89
Is your favorite CI provider missing? Just create an issue
910
[here](https://github.com/codechecks/monorepo). You can implement it on your own, read this
1011
[quick guide](adding-new-ci.md)
1112

13+
## Github Actions
14+
15+
1. Provide CC_SECRET value in your projects settings
16+
2. Pass it explicitly to the job.
17+
18+
Example:
19+
20+
```yml
21+
on: push
22+
name: Mainflow
23+
jobs:
24+
build-and-codechecks:
25+
name: build and run codechecks
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: actions/checkout@master
29+
- name: yarn
30+
run: |
31+
yarn install --frozen-lockfile
32+
33+
npx codechecks
34+
env:
35+
CC_SECRET: ${{ secrets.CC_SECRET }}
36+
```
37+
38+
NOTE: It requires
39+
[speculative-branch execution](https://github.com/codechecks/docs/blob/master/configuration.md#speculative-branch-execution)
40+
feature. So please configure branch priority if you use other branches than `master`.
41+
1242
## Semaphore CI Known issues
1343

1444
Note that passing secrets requires specifying

0 commit comments

Comments
 (0)