Skip to content

Latest commit

 

History

History
105 lines (72 loc) · 3.5 KB

README.md

File metadata and controls

105 lines (72 loc) · 3.5 KB
Raw

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:

  • github-token (required) Must be in form github-token: ${{ secrets.github_token }}; Coveralls uses this token to verify the posted coverage data on the repo and create a new check based on the results.
  • path-to-lcov (optional), default: './covrerage/lcov.info') Local path to the lcov output file produced by your test suite. An error will be thrown if the file can't be found.
  • parallel (optional) Set to true for parallel (or matrix) based steps, where multiple posts to Coveralls will be performed in the check.
  • 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.
  • coveralls-endpoint (optional) Hostname and protocol: https://<host>; Specifies a Coveralls Enterprise hostname.

Outputs:

  • coveralls-api-response: 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@master

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

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

      - name: Coveralls
        uses: coverallsapp/github-action
        with:
          github-token: ${{ secrets.github_token }}

Complete Parallel Job Example:

  on: ["push","pull_request"]

  name: Test Coveralls Parallel

  jobs:

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

      - uses: actions/checkout@master

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

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

      - name: Coveralls Parallel
        uses: coverallsapp/github-action
        with:
          github-token: ${{ secrets.github_token }}
          parallel: true
          path-to-lcov: ./coverage/lcov.info # optional (default value)

      - name: Coveralls Finished
        uses: coverallsapp/github-action
        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

gif placeholder

MIT License

Contributing