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:

Name	Requirement	Description
`github-token`	required	Default if not specified: `${{ github.token }}`. Can be also specified this way: `github-token: ${{ secrets.GITHUB_TOKEN }}`; Coveralls uses this token to verify the appropriate repo at Coveralls and send any new status updates based on your coverage results. This variable is built into Github Actions, so do not add it to your secrets store. More Info
`file`	optional	Default: all coverage files that could be found. Local path to the coverage report file produced by your test suite. An error will be thrown if no file was found. This is the file that will be sent to the Coveralls API. Leave empty if you want to combine many files reports.
`files`	optional	Default: all coverage files that could be found. Space-separated list of coverage report files produced by your test suite. Example: `files: coverage/test1.lcov coverage/test2.lcov`
`format`	optional	Force coverage report file format. If not specified, coveralls will try to detect the format based on file extension and/or content. Possible values: `lcov`, `simplecov`, `cobertura`, `jacoco`, `gcov`, `golang`, `python`. See also actual supported coverage report formats list.
`flag-name`	optional (unique required if parallel)	Job flag name, e.g. "Unit", "Functional", or "Integration". Will be shown in the Coveralls UI.
`parallel`	optional	Set to true for parallel (or matrix) based steps, where multiple posts to Coveralls will be performed in the check. `flag-name` needs to be set and unique, e.g. `flag-name: run ${{ join(matrix.*, ' - ') }}`
`parallel-finished`	optional	Set to true in the last job, after the other parallel jobs steps have completed, this will send a webhook to Coveralls to set the build complete.
`carryforward`	optional	Comma separated flags used to carryforward results from previous builds if some of the parallel jobs are missing. Used only with `parallel-finished`.
`coveralls-endpoint`	optional	Hostname and protocol: `https://<host>`; Specifies a Coveralls Enterprise hostname.
`allow-empty`	optional	Default: `false`. Don't fail if coverage report is empty or contains no coverage data.
`base-path`	optional	Path to the root folder of the project the coverage was collected in. Should be used in monorepos so that coveralls can process the LCOV correctly (e.g. packages/my-project)
`git-branch`	optional	Default: GITHUB_REF environment variable. Override the branch name.
`git-commit`	optional	Default: GITHUB_SHA environment variable. Override the commit SHA.
`compare-ref`	optional	Branch name to compare coverage with. Specify if you want to always check coverage change for PRs against one branch.
`compare-sha`	optional	Commit SHA to compare coverage with.
`debug`	optional	Default: `false`. Set to `true` to enable debug logging.
`measure`	optional	Default: `false`. Set to `true` to enable time time measurement logging.
`fail-on-error`	optional	Default: `true`. Set to `false` to avoid CI failure when upload fails due to any errors.

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/checkout@v1

    - 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@3
    - name: Use Node.js 16.x
      uses: actions/setup-node@3
      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:

A new function f without test coverage is added.
The changes are committed and pushed to a new branch "function/f"
The workflow runs on GitHub Actions.
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.
Line-by-line results indicate the new function is missing coverage.
Create a pull request with the new branch.
The pull_request check runs and the resulting coverage data triggers a fail status.
A detailed comment is posted.

Troubleshooting:

Coveralls comments aren't added to my pull request

Ensure that:

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

on: ["push", "pull_request"]

You have invited the @coveralls user to your repository with Role: Write
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 }}

coverallsapp/github-action

coverallsapp

Reviews

Repository Details