https://github.com/jpb06/coverage-badges-action
Github action generating coverage badges from a coverage json summary
https://github.com/jpb06/coverage-badges-action
badges effect-ts github-actions jest test-coverage vitest
Last synced: 5 months ago
JSON representation
Github action generating coverage badges from a coverage json summary
- Host: GitHub
- URL: https://github.com/jpb06/coverage-badges-action
- Owner: jpb06
- License: mit
- Created: 2023-07-11T17:35:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-13T23:52:22.000Z (5 months ago)
- Last Synced: 2025-09-14T01:21:15.614Z (5 months ago)
- Topics: badges, effect-ts, github-actions, jest, test-coverage, vitest
- Language: TypeScript
- Homepage:
- Size: 10.6 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# coverage-badges-action
[](https://open.vscode.dev/jpb06/coverage-badges-action)
[](https://sonarcloud.io/summary/new_code?id=jpb06_coverage-badges-action)
[](https://sonarcloud.io/dashboard?id=jpb06_coverage-badges-action)
[](https://sonarcloud.io/dashboard?id=jpb06_coverage-badges-action)
[](https://sonarcloud.io/dashboard?id=jpb06_coverage-badges-action)
[](https://sonarcloud.io/dashboard?id=jpb06_coverage-badges-action)
[](https://sonarcloud.io/summary/new_code?id=jpb06_coverage-badges-action)
[](https://sonarcloud.io/summary/new_code?id=jpb06_coverage-badges-action)
[](https://sonarcloud.io/dashboard?id=jpb06_coverage-badges-action)
[](https://sonarcloud.io/summary/new_code?id=jpb06_coverage-badges-action)
[](https://sonarcloud.io/summary/new_code?id=jpb06_coverage-badges-action)
[](https://sonarcloud.io/dashboard?id=jpb06_coverage-badges-action)
Generating coverage badges and pushing them to the repository.
## ⚡ Description
This github action generates testing coverage badges from a coverage summary and pushes them to the repo at `./badges`. There is five badges generated:
You can use them on a readme like so:
```markdown
```
## ⚡ Requirements
You will need to add json-summary to coverage reporters in your test runner config. You will also need to run your tests suite before calling this action in your ci workflow. See `usage` for an example.
### 🔶 vitest
`vite config`
```typescript
import { defineConfig } from 'vitest/config';
export default defineConfig({
test: {
coverage: {
reporter: ['json-summary'],
// ...
},
},
});
```
### 🔶 jest
`jest config`
```javascript
module.exports = {
coverageReporters: ["json-summary"];
// ...
};
```
## ⚡ Inputs
### 🔶 `no-commit`
If set to `true`, badges won't be committed by the github action.
> Default value: **false**
### 🔶 `branches`
Branches on which the badges should be generated, separated by commas. Optionally, you can set the value as `*` to specify generation should always happen.
> Default value: **master,main**
### 🔶 `target-branch`
The branch on which generated badges should be pushed. If unset, the current branch (on which the action is ran against) will be used.
### 🔶 `coverage-summary-path`
Jest coverage summary paths (json-summary). Defining this may be useful if you need to run this action on a monorepo. Can be an array of glob paths.
> Default value:
```yaml |
./coverage/coverage-summary.json
```
### 🔶 `badges-icon`
The icon to use for the badges, as a simple icons slug. You can find slugs [here](https://simpleicons.org/).
> Default is [file-icons:test-generic](https://icon-sets.iconify.design/file-icons/test-generic/).
### 🔶 `badges-labels-prefix`
Label prefix for the generated badges text. For example if you use `Repo test coverage`, generated badges will have a label matching `Repo test coverage: {key}` where `key = 'total' | 'lines' | 'statements' | 'functions' | 'branches'`.
> Default value: **`Test coverage: `**
### 🔶 `commit-message`
Commit message of the commit with generated badges.
> Default value: **Updating coverage badges**
### 🔶 `commit-user`
Customizing the name of the user committing generated badges (optional).
> Default value: ****
### 🔶 `commit-user-email`
Customizing the email of the user committing generated badges (optional).
> Default value: **@users.noreply.github.com**
### 🔶 `output-folder`
Where badges should be written (optional).
> Default value: **./badges**
## ⚡ Usage
Let's first define an npm script to run jest in package.json, specifying the coverage option to generate a coverage report:
```json
{
"scripts": {
// in case you use jest
"test-ci": "jest --ci --coverage",
// or if you use vitest ...
"test-ci": "vitest --coverage --run"
}
}
```
Let's then define our workflow:
```yaml
name: ⚡ My ci things
on: [push]
jobs:
my-workflow:
name: 📣 Generate cool badges
runs-on: ubuntu-latest
steps:
# Necessary to push the generated badges to the repo
- name: ⬇️ Checkout repo
uses: actions/checkout@v4
# ...
# Necessary to generate the coverage report.
# Make sure to add 'json-summary' to the coverageReporters in jest options
- name: 🔍 Tests
run: yarn test-ci
- name: ⚙️ Generating coverage badges
uses: jpb06/coverage-badges-action@latest
with:
branches: master,preprod,staging
badges-icon: vitest
```
The badges will be generated when the action runs on the master, preprod or staging branch.
### 🔶 Using a custom jest coverage summary file path
In case you need to define a custom path for the coverage summary file, you can use the `coverage-summary-path` input like so:
```yaml
[...]
- name: ⚙️ Generating coverage badges
uses: jpb06/coverage-badges-action@latest
with:
coverage-summary-path: |
./my-module/coverage/coverage-summary.json
```
### 🔶 Generating badges from several subpaths for `coverage-summary-path` to generate badges from several reports (several apps in a monorepo for example):
You may use an array of wildcard glob paths when you want to generate badges for several summary reports. In the example, we will generate a set of badges for each app in our monorepo:
```yaml
[...]
- name: ⚙️ Generating coverage badges
uses: jpb06/coverage-badges-action@latest
with:
coverage-summary-path: |
./apps/**/coverage/coverage-summary.json
./libs/**/coverage/coverage-summary.json
```
Badges will be written in subfolders following the captured glob path folder structure.
So for example if we have three apps defined as `apps/front/auth`, `apps/front/dashboard` and `apps/back`, the generated folder structure would look like:
```bash
# Coverage badges for the auth frontend app
./badges/front/auth/*
# Coverage badges for the dashboard frontend app
./badges/front/dashboard/*
# Coverage badges for the backend app
./badges/back/*
```
### 🔶 Pushing generated badges to a custom branch
Your perpetual branches should be protected to avoid some people from force pushing on them for example. Sadly there is no way to push badges to a protected branch 😿.
A workaround is to push them to a custom branch. Here is an example using a `badges` branch:
```yaml
name: ⚡ Generate badges on custom branch
on:
push:
branches:
- main
jobs:
generate-badges-on-custom-branch:
name: 🏷️ Generate badges on the badges branch
runs-on: ubuntu-latest
steps:
- name: ⬇️ Checkout repo
uses: actions/checkout@v4
- name: 📦 Setup pnpm
uses: pnpm/action-setup@v4
with:
version: latest
- name: ⎔ Setup node
uses: actions/setup-node@v4
with:
node-version-file: '.node-version'
registry-url: 'https://registry.npmjs.org'
cache: 'pnpm'
cache-dependency-path: ./package.json
- name: 📥 Install deps
run: pnpm install --frozen-lockfile
- name: 🔴 Delete remote badges branch
run: git push origin --delete badges
- name: ➕ Create badges branch
run: git checkout -b badges
- name: 🔍 Tests
run: pnpm test-ci
- name: ⚙️ Generating coverage badges
uses: jpb06/coverage-badges-action@latest
with:
branches: '*'
target-branch: badges
- name: ⬆️ Push badges branch
run: git push origin badges
```