https://github.com/tj-actions/coverage-badge-go
:octocat: Generate coverage badge for go modules
https://github.com/tj-actions/coverage-badge-go
actions code-coverage code-coverage-checker coverage coverage-report coverage-testing github github-actions go-coverage golang golang-action golang-coverage golang-coverage-profile
Last synced: 18 days ago
JSON representation
:octocat: Generate coverage badge for go modules
- Host: GitHub
- URL: https://github.com/tj-actions/coverage-badge-go
- Owner: tj-actions
- License: mit
- Created: 2021-10-15T20:46:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-23T12:12:14.000Z (about 1 month ago)
- Last Synced: 2025-04-03T08:29:34.832Z (19 days ago)
- Topics: actions, code-coverage, code-coverage-checker, coverage, coverage-report, coverage-testing, github, github-actions, go-coverage, golang, golang-action, golang-coverage, golang-coverage-profile
- Language: Go
- Homepage:
- Size: 375 KB
- Stars: 76
- Watchers: 3
- Forks: 33
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
[](https://github.com/search?o=desc\&q=tj-actions+coverage-badge-go+path%3A.github%2Fworkflows+language%3AYAML\&s=\&type=Code)
[](#contributors-)
## coverage-badge-go
Generate a coverage badge like this one for your Golang projects without uploading results to a third party.
👇
[](https://github.com/tj-actions/coverage-badge-go/actions?query=workflow%3ACI)
[](https://github.com/tj-actions/coverage-badge-go/actions/workflows/test.yml)
[](https://github.com/tj-actions/coverage-badge-go/actions?query=workflow%3A%22Update+release+version.%22)
## Usage
```yaml
name: Generate code coverage badge
on:
pull_request:
branches:
- main
jobs:
test:
runs-on: ubuntu-latest
name: Update coverage badge
steps:
- name: Checkout
uses: actions/checkout@v4
with:
persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
- name: Setup go
uses: actions/setup-go@v4
with:
go-version-file: 'go.mod'
- name: Run Test
run: |
go test -v ./... -covermode=count -coverprofile=coverage.out
go tool cover -func=coverage.out -o=coverage.out
- name: Go Coverage Badge # Pass the `coverage.out` output to this action
uses: tj-actions/coverage-badge-go@v2
with:
filename: coverage.out
- name: Verify Changed files
uses: tj-actions/verify-changed-files@v16
id: verify-changed-files
with:
files: README.md
- name: Commit changes
if: steps.verify-changed-files.outputs.files_changed == 'true'
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add README.md
git commit -m "chore: Updated coverage badge."
- name: Push changes
if: steps.verify-changed-files.outputs.files_changed == 'true'
uses: ad-m/github-push-action@master
with:
github_token: ${{ github.token }}
branch: ${{ github.head_ref }}
```
## Signed commits
In order to create signed commits see full guide [here](https://httgp.com/signing-commits-in-github-actions/)
## Inputs
```yaml
- uses: tj-actions/coverage-badge-go@v2
id: coverage-badge-go
with:
# Color of the badge -
# green/yellow/red
# Type: string
color: ''
# File containing the tests output
# Type: string
# Default: "coverage.out"
filename: ''
# At what percentage does the
# badge become green instead of
# yellow (default: 70)
# Type: string
green: ''
# Optional URL when you click
# the badge
# Type: string
link: ''
# Target file (default "README.md")
# Type: string
target: ''
# Text on the left side
# of the badge (default: "Coverage")
# Type: string
text: ''
# Text on the right side
# of the badge
# Type: string
value: ''
# At what percentage does the
# badge become yellow instead of
# red (default 30)
# Type: string
yellow: ''
```
* Free software: [MIT license](LICENSE)
If you feel generous and want to show some extra appreciation:
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[buymeacoffee]: https://www.buymeacoffee.com/jackton1
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
## Credits
This package was created with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) using [cookiecutter-action](https://github.com/tj-actions/cookiecutter-action)
* [gobadge](https://github.com/AlexBeauchemin/gobadge)
* [gobinaries](https://github.com/tj/gobinaries)
## Report Bugs
Report bugs at https://github.com/tj-actions/coverage-badge-go/issues.
If you are reporting a bug, please include:
* Your operating system name and version.
* Any details about your workflow that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
