A GitHub Action for creating markdown embeddable badges, saved to your repository, directly from an LCOV data file.

After looking for and testing several options to create a dynamic badge for code coverage from Bazel, and I couldn't find one that cleanly read the bazel coverage //... output files, so, I created this. This project is a solution for many repositories that I have under development to get a quick view on code health from the README.md files.

This work is inspired by the work from schneegans/[email protected] with a difference in that it evaluates the LCOV data format, and downloads the SVG file from badges.io, saving it to the repository under 'coverage.svg'.

Once generated, it MAY be linked in a README.md or other markdown file.

Add the following ignore to your build file:

on:
  push:
    branches:
      - main
    paths-ignore:
      - "**/coverage.svg"
  pull_request:

IMPORTANT: YOU MUST ADD THE IGNORE TO YOUR BUILD PROCESS, FAILURE TO DO SO WILL CAUSE A BUILD LOOP.

...
steps:
  - uses: ImBIOS/lcov-coverage-badge@v1
    with:
      file: ./target/coverage.dat

Add the badge file to a README.md file or AsciiDoc as a link.

![coverage](coverage.svg)

Example:

...
steps:
- uses: ImBIOS/lcov-coverage-badge@v1
  with:
    file: ./target/coverage.dat
    access_token: ${{ secret.COVERAGE_TOKEN }}
    style: flat
    icon_name: googlecloud,
    icon_color: 'ffffff',
    label: 'Coverage'
    label_color: 'ffffff'
    critical: 60
    criticalColor: '9c2c9c'
    warning: 75
    warningColor: 'd68f0c'
    success_color: '43ad43'
    message_color: 'ffffff'

• coverage_functions_found - total functions found
• coverage_functions_hit - total functions hit (any > 0)
• coverage_lines_found total line count
• coverage_lines_hit - total lines hit (any > 0)
• coverage_score - The score lines hit / lines found
• coverage_badge_url - The URL used to generate the badge

This project is released under the Apache 2.0 license, please read the License File file, or visit Apache 2 License for more information.