Skip to content
award

GitHub Action

Go coverage report gha

v1.0.1 Latest version

Go coverage report gha

award

Go coverage report gha

This action updates adds an HTML coverage report and SVG badge to your wiki

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Go coverage report gha

uses: crowdriff/go-coverage-gha@v1.0.1

Learn more about this action in crowdriff/go-coverage-gha

Choose a version

Go coverage report

A GitHub Action to add a coverage report and badge to your Go repo.

Apply it to your repo by adding this step to one of your workflows:

- name: Update coverage report
  uses: crowdriff/go-coverage-gha@v0

Your repo needs to have a Wiki for the action to work, and workflows need to have read and write permissions to the repo.

Complete example:

- name: Test
  run: go test -v ./...

- name: Update coverage report
  uses: crowdriff/go-coverage-gha@v0
  if: |
    matrix.os == 'ubuntu-latest' &&
    github.event_name == 'push'  
  continue-on-error: true

The action generates an HTML report and SVG badge, and saves them as “hidden” files in your Wiki.

To add a coverage badge to your README.md, use this Markdown snippet:

[![Go Coverage](https://github.com/USER/REPO/wiki/coverage.svg)](https://raw.githack.com/wiki/USER/REPO/coverage.html)

Clicking on the badge opens the coverage report.

The action will also log to the Wiki the unix timestamp and coverage of every run,

Use manually or as a pre-commit hook

The script can also be run manually, or as a pre-commit hook.

Credits