beshrkayali / cobertura-action

GitHub Action to report cobertura coverage

Cobertura action

GitHub Action which parse a XML cobertura report and display the metrics in a GitHub Pull Request.

Many coverage tools can be configured to output cobertura reports:

• coverage.py
• Istanbul
• Maven
• simplecov

Note that this action can only run on pull requests being opened from the same repository. This action will not currently work for pull requests from forks -- like is common in open source projects -- because the token for forked pull request workflows does not have write permissions. Hopefully GitHub will have a solution for this in the future.

How it looks like

Inputs

repo_token Required

The GITHUB_TOKEN. See details.

path

The to the cobertura report. Defaults to coverage.xml. If a glob pattern is provided it will take the first match.

skip_covered

If files with 100% coverage should be ignored. Defaults to true.

minimum_coverage

The minimum allowed coverage percentage as an integer.

show_line

Show line rate as specific column.

show_branch

Show branch rate as specific column.

show_class_names

Show class names instead of file names.

only_changed_files

Only show coverage for changed files.

report_name

Use a unique name for the report and comment.

pull_request_number Optional

Pull request number associated with the report. This property should be used when workflow trigger is different than pull_request.

Example usage

on:
  pull_request:
    types: [opened]
    branches:
      - master
jobs:
  coverage:
    runs-on: ubuntu-latest
    steps:
      - uses: 5monkeys/cobertura-action@master
        with:
          path: src/test.xml
          repo_token: ${{ secrets.GITHUB_TOKEN }}
          minimum_coverage: 75