mishakav/Jest Coverage Comment

Comments a pull request or commit with the Jest code coverage badge, full report and tests summary

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
github-tokenGitHub API Access Tokenyes${{ github.token }}
issue-numberPull request number to comment on (required for workflow_dispatch/workflow_run events)no""
titleMain title for the commentno
coverage-summary-pathThe location of the coverage-summary of Jestno./coverage/coverage-summary.json
summary-titleTitle for the coverage summaryno""
badge-titleTitle for the badge iconnoCoverage
text-instead-badgeUse simple text instead of badge images for coverage displaynofalse
hide-summaryHide coverage summary reportnofalse
hide-commentHide the whole comment (use when you need only `output`)nofalse
remove-links-to-filesRemove links to files (useful when summary-report is too big)nofalse
remove-links-to-linesRemove links to lines (useful when summary-report is too big)nofalse
create-new-commentWhen false, will update the same comment, otherwise will publish new comment on each runnofalse
junitxml-pathThe location of the junitxml path (npm package `jest-junit` should be installed)no""
junitxml-titleTitle for summary for junitxmlno""
coverage-pathThe location of the coverage.txt (Jest console output)no""
coverage-titleTitle for the coverage reportnoCoverage Report
coverage-path-prefixPrefix for path when link to files in commentno""
report-only-changed-filesShow in report only changed files for this commit, and not all filesnofalse
multiple-filesYou can pass array of `json-summary.json` files and generate single comment with table of results. Single line should look like `Title1, ./path/to/json-summary.json` no""
multiple-junitxml-filesYou can pass array of `junit.xml` files and generate single comment with table of results. Single line should look like `Title1, ./path/to/junit.xml` no""
unique-id-for-commentWhen running in a matrix, pass the matrix value, so each comment will be updated its own commentno""
namedescription
coverageValue indicating the coverage percentage of your report based on Jest, example 78
colorColor of coverage report
summaryHtmlThe HTML of the coverage summary report (markdown table)
testsTotal number of tests, get from `junitxml`
skippedTotal number of skipped tests, get from `junitxml`
failuresTotal number of tests with failures, get from `junitxml`
errorsTotal number of tests with errors, get from `junitxml`
timeSeconds that took to run all the tests, get from `junitxml`
linesLines covered, get from Jest text report
branchesBranches covered, get from Jest text report
functionsFunctions covered, get from Jest text report
statementsStatements covered, get from Jest text report