Coverbot

Fast tool to track code coverage, get your API key at https://devhub.tools

Usage

# ...

on:
  # pull_request trigger is required for annotations and patch coverage
  pull_request:
  # you should also run the coverage check on your default branch so
  # PR runs can compare against it
  push:
    branches:
      - main

# these are the minimum permissions needed
permissions:
  checks: write
  contents: read
  pull-requests: read
  statuses: write

jobs:
  tests:
    # ...

    steps:
    # ...

    - name: Check Code Coverage
      uses: devhub-tools/coverbot-action@v1
      with:
        format: elixir
        file: cover/excoveralls.json
        junit_folder: junit
        devhub_api_key: ${{ secrets.DEVHUB_API_KEY}}
        github_token: ${{ secrets.GITHUB_TOKEN}}

Inputs

• domain: (Required) The domain of your Devhub instance.

• format: (Required) file format (currently only elixir, go, lcov, and ruby are supported, reach out to support@devhub.tools for expanded language support).

• file: (Required) A json file containing code coverage results.

• junit_folder: (Optional) A folder containing JUnit XML files. Make sure the name of each file reflects the name of the test suite. In this way, different test suite runs can be grouped under the same test suite.

• subdirectory: (Optional) Path prefix for the project being measured. Set this when reporting coverage for a subproject in a monorepo (e.g. app, packages/web). Multiple jobs running for the same commit with different subdirectory values are stored as separate uploads and rolled up into a single consolidated coverage status (see Monorepo support).

• devhub_api_key: (Required) You will need to create an API key in the settings of your installed app and save it as a secret in GitHub Actions settings.

• github_token: (Required) Access from ${{ secrets.GITHUB_TOKEN }}

Outputs

• covered: Number of lines covered.

• relevant: Number of lines considered relevant.

• percentage: The coverage percentage.

Monorepo support

For monorepos with multiple projects under one repository, run the action once per project with a different subdirectory:. Each upload is stored separately, and the coverbot commit status reflects the consolidated total across every upload received for that sha.

jobs:
  coverage-app:
    steps:
      - uses: devhub-tools/coverbot-action@v1
        with:
          format: elixir
          file: app/cover/excoveralls.json
          subdirectory: app
          domain: ${{ vars.DEVHUB_DOMAIN }}
          devhub_api_key: ${{ secrets.DEVHUB_API_KEY }}
          github_token: ${{ secrets.GITHUB_TOKEN }}

  coverage-web:
    steps:
      - uses: devhub-tools/coverbot-action@v1
        with:
          format: lcov
          file: web/coverage/lcov.info
          subdirectory: web
          domain: ${{ vars.DEVHUB_DOMAIN }}
          devhub_api_key: ${{ secrets.DEVHUB_API_KEY }}
          github_token: ${{ secrets.GITHUB_TOKEN }}

Each job posts to the same coverbot status; whichever finishes second sees both totals summed in the message (e.g. 30 lines covered out of 200 (15.00%)).

Add the coverage badge to your README.md

![coverbot](https://img.shields.io/endpoint?url=https://${DOMAIN}/api/v1/coverbot/${OWNER}/${REPO}/${BRANCH}/badge.json)