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

This action will not currently work when triggered by pull requests from forks, like is common in open source projects. This is because the token for forked pull request workflows does not have write permissions on the target repository. Hopefully GitHub will have a solution for this in the future. In the meantime one can use utilize multiple workflows and artifacts to circumvent this. See the workflows in this project for an implementation example and this blog post https://securitylab.github.com/research/github-actions-preventing-pwn-requests.

A comment is added to the pull request with the coverage report.

A check is added to the workflow run.

The check will succeed or fail based on your threshold when fail_below_threshold is set to true, this allows you to mandate coverage checks pass on your protected branches.

The GITHUB_TOKEN. Defaults to ${{github.token}}

The path to the cobertura report. Defaults to coverage.xml. Glob pattern is supported, for example coverage/*.xml.

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

The minimum allowed coverage percentage as an integer.

Fail the action when the minimum coverage was not met.

Show line rate as specific column.

Show branch rate as specific column.

Show class names instead of file names.

Show line numbers of statements, per module, that weren't executed.

Crop missing line numbers strings that exceeds this length, provided as an integer.

Default is no crop.

(Note: "…" is appended to a cropped string)

Link missing line numbers. This only has an effect when show_missing is set to true. Defaults to false.

Allows specifying a source directory for link_missing_lines, that will be inserted into the resulting URLs, in-between the commit hash and the file path.

Only show coverage for changed files.

Use a unique name for the report and comment.

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

If no pull request can determine the action will skip adding the comment.

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

• Install deps: npm ci
• Run tests: npm run test
• Run lint: npm run lint
• Package application npm run package. Remember to run this before committing anything.