Coveralls GitHub Action

This GitHub Action posts your test suite's LCOV 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

The action's step needs to run after your test suite has outputted an LCOV file. Most major test runners can be configured to do so; if you're using Node, see more info here.

Inputs:

Outputs:

• coveralls-api-result: JSON response from the Coveralls API with a status code and url for the Job on Coveralls.

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/[email protected]

    - name: Use Node.js 10.x
      uses: actions/[email protected]
      with:
        node-version: 10.x

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

    - name: Coveralls
      uses: coverallsapp/[email protected]
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}

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/[email protected]
    - name: Use Node.js 10.x
      uses: actions/[email protected]
      with:
        version: 10.x

    - name: npm install
      run: npm install

    - name: Test ${{ matrix.test_number }}
      run: make test-coverage-${{ matrix.test_number }}
    - name: Coveralls Parallel
      uses: coverallsapp/[email protected]
      with:
        github-token: ${{ secrets.github_token }}
        flag-name: run-${{ matrix.test_number }}
        parallel: true

  finish:
    needs: test
    runs-on: ubuntu-latest
    steps:
    - name: Coveralls Finished
      uses: coverallsapp/[email protected]
      with:
        github-token: ${{ secrets.github_token }}
        parallel-finished: true

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 Action runs on GitHub CI.
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 your workflow that invokes the Coveralls action runs on pull requests, e.g.:

on: ["push", "pull_request"]

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