GitHub Action
Comment Test Coverage with delete filter by title
1.0.3
Latest version
A GitHub action to comment on a PR on GitHub with a simple test coverage summary table that edits itself on successive pushes to the same PR.
- Add
"codeCoverage": true,
under test > options in angular.json - In your karma.conf.js set coverageIstanbulReporter.reports to include
json-summary
and save it to the /coverage directory if using the sample setup below - Use in your workflow as illustrated below:
name: test-pull-request
on: [pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v1
- name: Run Jasmine tests
run: npm run test -- --no-watch --no-progress --browsers=ChromeHeadlessCI
- name: Comment Test Coverage
uses: lucianogorza/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
path: coverage/coverage-summary.json
title: Karma Test Coverage
- Add
"codeCoverage": true,
under test > options in angular.json - In your jest.config.js set coverageReporters to include
json-summary
and set coverageDirectory to 'coverage' if using the path in the sample setup above. - Use in your workflow as illustrated above in the Karma example.
token
(required) - The GitHub authentication token (workflows automatically set this for you, nothing needed here)path
(required) - Path to your coverage-summary.json filetitle
(optional) - Title of comment in PR (defaults to "Test Coverage")
Feel free to submit a PR to this repo and ask me to update the action, but if you'd like to create your own action:
- Clone down repo,
npm install
, and make changes - Run
npm run package
- Commit changes
- Create a new release on GitHub to publish latest version of the action. See https://help.github.com/en/actions/building-actions/publishing-actions-in-github-marketplace
Repurposed from https://github.com/peter-evans/commit-comment, Copyright (c) 2019 Peter Evans and https://github.com/mshick/add-pr-comment, Copyright (c) 2019 Michael Shick