supported-ci.md

Supported CI providers

• Circle CI
• Travis CI
• Github Actions
• BuildKite CI
• Semaphore CI

Is your favorite CI provider missing? Just create an issue here. You can implement it on your own, read this quick guide

Github Actions

1. Provide CC_SECRET value in your projects settings
2. Pass it explicitly to the job.

Example:

on: push
name: Mainflow
jobs:
  build-and-codechecks:
    name: build and run codechecks
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: yarn
        run: |
          yarn install --frozen-lockfile

          npx codechecks
        env:
          CC_SECRET: ${{ secrets.CC_SECRET }}

NOTE: It requires speculative-branch execution feature. So please configure branch priority if you use other branches than master.

Semaphore CI Known issues

Note that passing secrets requires specifying

secrets:
  - name: CC_SECRET

in task description.

Unfortunately, at this time Semaphore using codechecks won't have access to detailed PR info (things like PR title or body information). It also requires speculative-branch execution feature. So please configure branch priority if you use other branches than master.

In Semaphore CI settings remember to turn off CI execution on pull requests.