Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/paambaati/codeclimate-action

GitHub Action to send your code coverage to CodeClimate
https://github.com/paambaati/codeclimate-action

codeclimate coverage github-actions nodejs quality typescript

Last synced: 24 days ago
JSON representation

GitHub Action to send your code coverage to CodeClimate

Lists

README 

        
# codeclimate-action



[![Test Coverage](https://api.codeclimate.com/v1/badges/8f2233d4c51c92ad427c/test_coverage)](https://codeclimate.com/github/paambaati/codeclimate-action/test_coverage)

[![Build Status](https://github.com/paambaati/codeclimate-action/actions/workflows/ci.yml/badge.svg)](https://github.com/paambaati/codeclimate-action/actions/workflows/ci.yml)

[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)



A GitHub action that publishes your code coverage to [Code Climate](http://codeclimate.com/).



## Usage



This action requires that you set the [`CC_TEST_REPORTER_ID`](https://docs.codeclimate.com/docs/configuring-test-coverage) environment variable. You can find it under Repo Settings in your Code Climate project.



### Inputs



| Input               | Default         | Description                                                                        |

| ------------------- | --------------- | ---------------------------------------------------------------------------------- |

| `coverageCommand`   |                 | The actual command that should be executed to run your tests and capture coverage. |

| `workingDirectory`  |                 | Specify a custom working directory where the coverage command should be executed.  |

| `debug`             | `false`         | Enable Code Coverage debug output when set to `true`.                              |

| `coverageLocations` |                 | Locations to find code coverage as a multiline string.
Each line should be of the form `:`.
`type` can be any one of `clover, cobertura, coverage.py, excoveralls, gcov, gocov, jacoco, lcov, lcov-json, simplecov, xccov`. See examples below. |

| `prefix`            | `undefined`     | See [`--prefix`](https://docs.codeclimate.com/docs/configuring-test-coverage)      |

| `verifyDownload`    | `true`          | Verifies the downloaded Code Climate reporter binary's checksum and GPG signature. See [Verifying binaries](https://github.com/codeclimate/test-reporter#verifying-binaries)      |



> **Note**

> If you are a Ruby developer using [SimpleCov](https://github.com/simplecov-ruby/simplecov), other users have recommended installing an additional gem – `gem "simplecov_json_formatter"` – this gem fixes `json` error from the default `coverage/.resultset.json` output from SimpleCov.



#### Example



```yaml

steps:

  - name: Test & publish code coverage

    uses: paambaati/[email protected]

    env:

      CC_TEST_REPORTER_ID: 

    with:

      coverageCommand: npm run coverage

      debug: true

```



#### Example with only upload



When you've already generated the coverage report in a previous step and wish to just upload the coverage data to Code Climate, you can leave out the `coverageCommand` option.



```yaml

steps:

  - name: Test & publish code coverage

    uses: paambaati/[email protected]

    env:

      CC_TEST_REPORTER_ID: 

```



#### Example with wildcard (glob) pattern



This action supports basic glob patterns to search for files matching given patterns. It uses [`@actions/glob`](https://github.com/actions/toolkit/tree/master/packages/glob#basic) to expand the glob patterns.



```yaml

steps:

  - name: Test & publish code coverage

    uses: paambaati/[email protected]

    env:

      CC_TEST_REPORTER_ID: 

    with:

      coverageCommand: yarn run coverage

      coverageLocations: |

        ${{github.workspace}}/*.lcov:lcov

```



#### Example with Jacoco



```yaml

steps:

  - name: Test & publish code coverage

    uses: paambaati/[email protected]

    env:

      # Set CC_TEST_REPORTER_ID as secret of your repo

      CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}

      JACOCO_SOURCE_PATH: "${{github.workspace}}/src/main/java"

    with:

      # The report file must be there, otherwise Code Climate won't find it

      coverageCommand: mvn test

      coverageLocations: ${{github.workspace}}/target/site/jacoco/jacoco.xml:jacoco

```



#### Example of multiple test coverages for monorepo with Jest



Let's say you have a monorepo with two folders —`client` and `server`, both with their own coverage folders and a `yarn coverage` script which runs Jest within both folders.



```json

"scripts": {

  "coverage": "yarn client coverage && yarn server coverage"

}

```



First be sure that paths in your `coverage/lcov.info` are correct; they should be either absolute or relative to the **root** of the monorepo. Open `lcov.info` and search for any path. For example —



```lcov

SF:src/server.ts

```



If you find a *relative* path like this (happens for Jest 25+), it's incorrect as it is relative to the sub-package. This can be fixed by configuring Jest to set the root of your monorepo —



```javascript

// server/jest.config.js

module.exports = {

  ...

  coverageReporters: [['lcov', { projectRoot: '..' }]]

  ...

};

```



```yaml

steps:

  - name: Test & publish code coverage

    uses: paambaati/[email protected]

    env:

      CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}

    with:

      coverageCommand: yarn run coverage

      coverageLocations: |

        ${{github.workspace}}/client/coverage/lcov.info:lcov

        ${{github.workspace}}/server/coverage/lcov.info:lcov

```



Example projects



1. [paambaati/websight](https://github.com/paambaati/websight/blob/5ab56bcc365ee73dd7937e87267db30f6357c4cd/.github/workflows/ci.yml#L33-L50)



2. [MartinNuc/coverage-ga-test](https://github.com/MartinNuc/coverage-ga-test/blob/master/.github/workflows/ci.yaml)