Warning

The Code Climate API has been disabled on July 18th, 2025.

Any attempts to upload coverage to the Code Climate API (via the cc-test-reporter) will result in failed CI builds.

To avoid disruption, you must remove (or comment out) any remaining references to the old cc-test-reporter within your CI scripts.

See the migration guide.

setup-codeclimate

⚙️ Set up your GitHub Actions workflow with Code Climate test reporter.

Quick Start

name: test
on: push
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Setup Code Climate
        uses: remarkablemark/setup-codeclimate@v2

      - name: Run Test and Upload Coverage
        run: |
          cc-test-reporter before-build
          # insert your test command here
          cc-test-reporter after-build --exit-code $?
        env:
          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}

Usage

See action.yml

Basic:

- uses: remarkablemark/setup-codeclimate@v2

Example:

- uses: remarkablemark/setup-codeclimate@v2
- run: |
    cc-test-reporter before-build
    npm test
    cc-test-reporter after-build --exit-code $?
  env:
    CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}

Inputs

codeclimate-version

Optional: The Code Climate test reporter version. Defaults to latest:

- uses: remarkablemark/setup-codeclimate@v2
  with:
    codeclimate-version: 0.11.1

cli-name

Optional: The Code Climate test reporter CLI name. Defaults to cc-test-reporter:

- uses: remarkablemark/setup-codeclimate@v2
  with:
    cli-name: cc-test-reporter

Examples

• remarkablemark/codeclimate-github-actions-examples

Contributions

👋 Contributions are welcome!

License

MIT