Skip to content

remarkablemark/setup-codeclimate

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Code Climate

setup-codeclimate

version build Maintainability Test Coverage

⚙️ 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

Contributions

Contributions are welcome!

License

MIT