This is a github action for combining/compiling code coverage from an nx monorepo (although will probably work for other mono/single repos).
- This will loop through the coverage folder which should contain all the projects and their coverage results.
- On a PR execution, this will update the PR with a PR Commit displaying the coverage results for those projects
- On a push execution, this will update coverage badges for all projects (using the gist method specified here
GitHub Action to combine/compile code coverage from an nx monorepo
- ✅ Code coverage comment for monorepo
- ✅ Code coverage diff if base provided
- ✅ Updates the Code coverage comment instead of adding new
The report is based on the coverage report generated by your test runner.
github-token:
required: true
description: Github token
no-coverage-ran:
required: true
description: true/false if no coverage was ran; useful if using nx affected and it returned no projects
type: boolean
coverage-folder:
required: false
description: path to folder containing project folders with coverage data (default 'coverage')
coverage-base-folder:
required: false
description: path to folder containing project folders with coverage data for diff/base comparison (default 'coverage-base')
gist-processing:
required: true
description: true/false should save results/badge to gist
type: boolean
gist-token:
required: false
description: 'Your secret with the gist scope for coverage badge; required if gist-processing not false'
gist-id:
required: false
description: 'The ID of the gist to use; required if gist-processing not false'
label-color:
description: 'The left color of the badge'
required: false
color:
description: 'The right color of the badge'
required: false
is-error:
description: 'The color will be red and cannot be overridden'
required: false
named-logo:
description: 'A logo name from simpleicons.org'
required: false
logo-svg:
description: 'An svg-string to be used as logo'
required: false
logo-color:
description: 'The color for the logo'
required: false
logo-width:
description: 'The space allocated for the logo'
required: false
logo-position:
description: 'The position of the logo'
required: false
style:
description: 'The style like "flat" or "social"'
required: false
cache-seconds:
description: 'The cache lifetime in seconds (must be greater than 300)'
required: false
hide-coverage-reports:
description: true/false to hide the coverage reports
type: boolean
required: true
hide-unchanged:
description: true/false to hide the coverage results that have no diffs
type: boolean
required: true- Perform gist setup from link
- Must run nx:affected test --coverage so the coverage results already exist
- name: Comment Code Coverage on PR
uses: dkhunt27/nx-code-coverage@v2
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
no-coverage-ran: false
coverage-folder: ./coverage
coverage-base-folder: ./coverage-base
gist-processing: true
gist-token: ${{ secrets.COVERAGE_BADGES_GIST_TOKEN }}
gist-id: d7e6b443a01eba615fd2a7c1215aec91
color: green
named-logo: jest
hide-coverage-reports: false
hide-unchanged: false-
See sample workflows
-
Hide Coverage Results See how hiding coverage reports affects the PR comment
- make new branch and make changes
npm run allgit commit/push changes- make PR back to main
- wait for pipelines to finish; then merge
git checkout maingit pullgit tag v1SKIP_HOOKS=true git push origin v1- in github, edit tag and sa 74B2 ve (this will push to marketplace)
npm run npm:checkThanks to the creators of the code that this was based on