GitHub Action
Jest Coverage Commenter
v2.0.2
Latest version
GitHub Action to create a PR comment detailing how well test files are covering code. You can run whatever test command you want, but make sure it uses the coverage reporter to match your reporter input (see below).
| key | default | required | description |
|---|---|---|---|
| github_token | n/a | true | A GitHub Token, the standard one is great. |
| test_command | npx jest --coverage |
false | The test command to run, that also runs coverage appropriately |
| reporter | text |
false | Possible types: text, text-summary. Set your --coverageReporters to match. text-summary should be used on large projects. |
| comment_prefix | ## Jest Coverage |
false | The message preceeding coverage report |
None
on: pull_request
jobs:
test-coverage:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
with:
fetch-depth: 0
- run: npm i
- name: Comment with Test Coverage
uses: dkershner6/jest-coverage-commenter-action@v2
with:
github_token: "${{ secrets.GITHUB_TOKEN }}"
test_command: "npm run test:coverage"For the standard text reporter, the most common jest coverageReporter, the comment on the PR looks like this, with expandable details:
For the text-summary reporter, you should run a jest command that includes --coverageReporters=text-summary. When this occurs and the reporter input is also set to text-summary, the PR comments looks like this:
All contributions are welcome, please open an issue or pull request.
To use this repository:
npm i -g pnpm(if don't have pnpm installed)pnpm inpx projen(this will ensure everything is setup correctly, and you can run this command at any time)- Good to make your changes!
- You can run
npx projen buildat any time to build the project.