Skip to content
codacy

GitHub Action

Codacy Coverage Reporter

v1.3.0 Latest version

Codacy Coverage Reporter

codacy

Codacy Coverage Reporter

Multi-language coverage reporter for Codacy

Installation

Copy and paste the following snippet into your .yml file.

              
- name: Codacy Coverage Reporter

              
  uses: codacy/codacy-coverage-reporter-action@v1.3.0
Learn more about this action in codacy/codacy-coverage-reporter-action

Choose a version

Codacy Coverage Reporter GitHub Action

Codacy Badge

🤖 Automated multi-language coverage reporter for Codacy

This action runs the codacy-coverage-reporter for all commits and pull requests with your Codacy configuration.

Usage

Create a new workflow .yml file in the .github/workflows/ directory.

.github/workflows/codacy-coverage-reporter.yml

name: codacy-coverage-reporter

on: ["push"]

jobs:
  codacy-coverage-reporter:
    runs-on: ubuntu-latest
    name: codacy-coverage-reporter
    steps:
      - uses: actions/checkout@v2
      - name: Run codacy-coverage-reporter
        uses: codacy/codacy-coverage-reporter-action@v1
        with:
          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
          # or
          # api-token: ${{ secrets.CODACY_API_TOKEN }}
          coverage-reports: cobertura.xml

Get the latest version from the Releases page.

Workflow options

Change these options in the workflow .yml file to meet your GitHub project needs:

Setting Description Recommended value
api-token Account API token ${{ secrets.CODACY_API_TOKEN }}
project-token Project API token ${{ secrets.CODACY_PROJECT_TOKEN }}
coverage-reports Optional comma-separated list of reports to send ''
language Optionally force associating a language with your coverage report ''
force-coverage-parser Optionally force using a specific coverage report parser ''