| github-token | The github-token to use.
| yes | ${{ github.token }} |
| checkout | Whether a checkout should be performed
| yes | false |
| override-comment | Overrides the comment on a PR.
| yes | false |
| recreate-comment | Triggers the (re-)creation of the comment in a PR, that is updated with the reports.
| yes | false |
| comment-enabled | Whether a comment on the PR should be posted.
| yes | true |
| comment-header | The header to identify the PR comment. This is an invisible tag on the comment.
| yes | reports |
| comment-message-failure | Message appended to the comment posted on the PR after the tests failed.
The message can be templated for replacement. The format feature of github-expressions (https://docs.github.com/en/actions/learn-github-actions/expressions#format) is used to replace placeholders. The following placeholder-mapping applies:
- {0} is inputs'.'report-name
- {1} is the number of successful tests
- {2} is the number of failed tests
- {3} is the number of skipped tests
- {4} is the URL to the HTML-Report
| yes | <details>
<summary><h3>😔 {0} failed</h3></summary>
| Passed | Failed | Skipped |
|--------|--------|---------|
| ✅ {1} | ❌ {2} | ⚠️ {3} |
You can see the report [here]({4}).
</details>
|
| comment-message-override | The new comment message. Notice that the old comment will be completely overridden.
| yes | ## 🚦Reports for run [#${{ github.run_number }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})🚦
Reports will be posted here as they get available.
|
| comment-message-recreate | Initial text for the comment posted on the PR. Subsequent messages will be appended.
| yes | ## 🚦Reports for run [#${{ github.run_number }}](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})🚦
Reports will be posted here as they get available.
|
| comment-message-success | Message appended to the comment posted on the PR after the tests succeeded.
The message can be templated for replacement. The format feature of github-expressions (https://docs.github.com/en/actions/learn-github-actions/expressions#format) is used to replace placeholders. The following placeholder-mapping applies:
- {0} is inputs'.'report-name
- {1} is the number of successful tests
- {2} is the number of failed tests
- {3} is the number of skipped tests
- {4} is the URL to the HTML-Report
| yes | <details>
<summary><h3>🥳 {0} passed</h3></summary>
| Passed | Failed | Skipped |
|--------|--------|---------|
| ✅ {1} | ❌ {2} | ⚠️ {3} |
You can see the report [here]({4}).
</details>
|
| comment-message-pr-number | The PR number to which the comment should be written.
| yes | ${{ github.event.number }} |
| download-artifact-name | The name of the artifact to download.
| yes | "" |
| download-artifact-pattern | The pattern of the artifacts to download.
| yes | "" |
| download-artifact-merge-multiple | If artifacts should be merged if multiple artifacts are downloaded.
| yes | false |
| download-artifact-run-id | The run-id for which the artifact should be downloaded.
| yes | ${{ github.run_id }} |
| report-fail-on-error | Whether an error in a test should fail the step.
| yes | true |
| report-list-suites | Limits which test suites are listed. Supported options:
- all
- failed
| yes | all |
| report-list-tests | Limits which test cases are listed. Supported options:
- all
- failed
- none
| yes | all |
| report-name | The name of the report. The Text "Report" will be appended to form the report name that is attached to the check.
So if we pass "JUnit" as report-name, the corresponding report will be called "JUnit Report".
| yes | JUnit |
| report-only-summary | Allows you to generate only the summary.
If enabled, the report will contain a table listing each test results file and the number of passed, failed, and skipped tests.
Detailed listing of test suites and test cases will be skipped.
| yes | false |
| report-path | A glob path to the report files.
| yes | **/*.xml |
| report-reporter | Format of test results. Supported options:
- dart-json
- dotnet-trx
- flutter-json
- java-junit
- jest-junit
- mocha-json
- mochawesome-json
| yes | java-junit |