Delta Coverage Report GitHub Action

The action creates check run with detailed coverage info based on the Delta-Coverage summary report. Also, the action creates a comment in the pull request with links to the check runs.

Inputs

• title (optional): The title of the comment. Default is Delta Coverage Check.
• summary-report-path: The path to the Delta-Coverage summary report json file.
• suppress-check-failures (optional): Suppress check run failures. If a PR contains label suppress-delta-coverage then the default value is true, otherwise false. Can be useful when you want to ignore coverage check failures.
• github-token (optional): The GitHub token to use for authentication.

If title is not blank then the previous comment generated by this action will be updated with the new report, otherwise a new comment will be created.

Outputs

• badges-dir - The directory where the coverage badges are stored.

Pre-requisites

Required permissions:

• issues: read
• pull-requests: write
• checks: write

Example usage

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      issues: read
      pull-requests: write
      checks: write
          
    steps:
      - name: Publish Delta Coverage Report
        uses: gw-kit/delta-coverage-action@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

The latest version:

Coverage Badges

The action generates coverage badges for each coverage view. The badges are generated based on full coverage summary data files created by Delta-Coverage plugin.

⚠️ Enabling of full coverage report is required:

deltaCoverageReport {
   reports {
      fullCoverageReport = true
   }
}

⚠️ Min required Delta-Coverage plugin is 3.4.0.

Badges example