A Github action to check if you didn't degrade your code coverage.

This action is split into two actions :

The update process is the one used to update coverage report for the main branch of the project. After calculation, it pushes results to a dedicated coverage branch.

Here is an exemple of how to use it (on a php project) :

name: Coverage update
on:
  push:
    branches:
      - main
jobs:
  coverage_update:
    runs-on: ubuntu-lastest
    steps:
      - uses: actions/checkout@v2
      - name: Install dependencies
        run: composer install --prefer-dist --no-progress --no-suggest
      - name: Run test suite
        run: make test
      - name: Coverage update
        uses: OpenClassrooms/[email protected]
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          action: update

Note that the Run test suite step will generate a clover file containing the coverage information. This action will use this file to generate the report.

If a "badge" property is defined in the configuration, the update action will generate an SVG badge and commit it in the coverage branch.

A file named coverage-history.json, persisted in the coverage branch, will be updated at each base coverage update. By querying it and using it in a visualization tool, you'll be able to share metrics regarding your coverage history easily.

name: Coverage check
on: [pull_request]
jobs:
  coverage_check:
    runs-on: ubuntu-lastest
    steps:
      - uses: actions/checkout@v2
      - name: Install dependencies
        run: composer install --prefer-dist --no-progress --no-suggest
      - name: Run test suite
        run: make test
      - name: Coverage check
        uses: OpenClassrooms/[email protected]
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          action: check

The output of this action is a comment on the PR to simply see if the coverage has been degraded or not, and an action failure in case of degradation.

After having cloned the project, run make install, that will install dependencies, and ncc (required to compile code before pushing it).

Compile code before committing by running this command: make