remarkablemark / setup-codeclimate

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

setup-codeclimate

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

Quick Start

- name: Setup Code Climate
  uses: remarkablemark/setup-codeclimate@v1

- 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:

steps:
  - uses: remarkablemark/setup-codeclimate@v1

Example:

steps:
  - uses: remarkablemark/setup-codeclimate@v1
  - 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@v1
  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@v1
  with:
    cli-name: cc-test-reporter

Examples

• remarkablemark/codeclimate-github-actions-examples

Contributions

Contributions are welcome!

License

MIT