Test Coverage Annotate - GitHub Action

A GitHub Action that enhances your code review process by providing visual insights into test coverage directly on your pull requests.

🔍 Overview

Test Coverage Annotate is a powerful GitHub Action that scans the changes in a pull request and utilizes the provided coverage report to display annotations on the PR, highlighting uncovered parts of the code. This allows developers and reviewers to quickly identify areas with insufficient test coverage and take appropriate actions.

💡 Features

• Seamlessly integrates into your pull request workflow.
• Provides actionable insights into code coverage.
• Customizable annotation style: choose between summarized or detailed annotations.
• Flexible annotation types: focus on lines, functions, or branches that need attention.
• Easy-to-use configuration with sensible defaults.
• Aility to integrate with Travis Jobs

⚙️ Configuration

Inputs

token (required)

The access token required to interact with the GitHub API for fetching pull request details.

coverage-info-path (optional)

The path to the coverage report file. This defaults to './coverage/lcov.info'.

annotation-coverage (optional)

Specifies the style of coverage annotations to display:

• summarize: Show a summary annotation on each file.
• detailed: Display line-level annotations directly in the code.

Defaults to 'summarize'.

annotation-type (optional)

The type of coverage aspects to annotate:

• lines: Annotate uncovered lines.
• functions: Annotate uncovered functions.
• branches: Annotate uncovered branches.
• all: Annotate all of the above aspects.

Defaults to 'all'.

🚀 Example Usage

To integrate test coverage annotations into your GitHub Actions workflow, you can use the test-coverage-annotate action like this:

uses: your-username/[email protected]
with:
  token: ${{ secrets.GITHUB_TOKEN }}
  coverage-info-path: './coverage/lcov.info'
  annotation-coverage: 'detailed'
  annotation-type: 'all'

This can also be used with Travis Jobs as that is how i'm using it within my organization, please get in touch if you want to go through the steps.

Note: If you are using actions/checkout in your workflow, make sure you add the fetch-depth: 0 parameter. This is necessary for the tool to access the coverage file properly.