Awesome

Coveralls GitHub Action

This GitHub Action posts your test suite's coverage data to coveralls.io for analysis, change tracking, and notifications. You don't need to add the repo to Coveralls first, it will be created when receiving the post.

When running on pull_request events, a comment will be added to the PR with details about how coverage will be affected if merged.

Usage

This action's step needs to run after your test suite has outputted a coverage report file. Most major test runners can be configured to do so, very likely with the adition of a test coverage library, such as simplecov for ruby, coverage.py for python, or istanbul or jest for javascript, etc.

Inputs:

Standard Example:

• This example assumes you're building a Node project using the command make test-coverage, demo here: nickmerwin/node-coveralls

on: ["push", "pull_request"]

name: Test Coveralls

jobs:

  build:
    name: Build
    runs-on: ubuntu-latest
    steps:

    - uses: actions/checkout@v4

    - name: Use Node.js 16.x
      uses: actions/setup-node@v3
      with:
        node-version: 16.x

    - name: npm install, make test-coverage
      run: |
        npm install
        make test-coverage

    - name: Coveralls
      uses: coverallsapp/github-action@v2

Complete Parallel Job Example:

on: ["push", "pull_request"]

name: Test Coveralls Parallel

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        test_number:
          - 1
          - 2
    steps:
    - uses: actions/checkout@v4
    - name: Use Node.js 16.x
      uses: actions/setup-node@v3
      with:
        node-version: 16.x

    - name: npm install
      run: npm install

    - name: Test ${{ matrix.test_number }}
      run: make test-coverage-${{ matrix.test_number }}
    - name: Coveralls Parallel
      uses: coverallsapp/github-action@v2
      with:
        flag-name: run-${{ join(matrix.*, '-') }}
        parallel: true

  finish:
    needs: test
    if: ${{ always() }}
    runs-on: ubuntu-latest
    steps:
    - name: Coveralls Finished
      uses: coverallsapp/github-action@v2
      with:
        parallel-finished: true
        carryforward: "run-1,run-2"

The "Coveralls Finished" step needs to run after all other steps have completed; it will let Coveralls know that all jobs in the build are done and aggregate coverage calculation can be calculated and notifications sent.

Demo

Steps shown:

1. A new function f without test coverage is added.
2. The changes are committed and pushed to a new branch "function/f"
3. The workflow runs on GitHub Actions.
4. The commit on GitHub shows a new check for Coveralls with details "First build on function-f at 92.0%", and links to the Job on Coveralls.
5. Line-by-line results indicate the new function is missing coverage.
6. Create a pull request with the new branch.
7. The pull_request check runs and the resulting coverage data triggers a fail status.
8. A detailed comment is posted.

Troubleshooting:

Coveralls comments aren't added to my pull request

Ensure that:

1. Your workflow invokes the Coveralls action runs on pull requests, e.g.:

on: ["push", "pull_request"]

2. You have invited the @coveralls user to your repository with Role: Write
3. You have enabled the "LEAVE COMMENTS?" setting in the "Pull Request Alerts" area in your Repo Settings page inside the Coveralls app.

Coveralls responds with "cannot find matching repository"

Ensure your workflow yaml line for the GitHub token matches exactly:

github-token: ${{ secrets.GITHUB_TOKEN }}

MIT License

Contributing