Skip to content

Commit 22da2ed

Browse files
mikepenzmikepenz
committed
- update README
1 parent 177df39 commit 22da2ed

File tree

1 file changed

+34
-32
lines changed

1 file changed

+34
-32
lines changed

‎README.md

+34-32
Original file line numberDiff line numberDiff line change
@@ -72,38 +72,40 @@ jobs:
7272
7373
### Inputs
7474
75-
| **Input** | **Description** |
76-
|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
77-
| `report_paths` | Optional. [Glob](https://github.com/actions/toolkit/tree/master/packages/glob) expression to junit report paths. Defaults to: `**/junit-reports/TEST-*.xml`. |
78-
| `token` | Optional. GitHub token for creating a check run. Set to `${{ github.token }}` by default. |
79-
| `test_files_prefix` | Optional. Prepends the provided prefix to test file paths within the report when annotating on GitHub. |
80-
| `exclude_sources` | Optional. Provide `,` seperated array of folders to ignore for source lookup. Defaults to: `/build/,/__pycache__/` |
81-
| `check_name` | Optional. Check name to use when creating a check run. The default is `JUnit Test Report`. |
82-
| `suite_regex` | REMOVED (as of v5). Instead use `check_title_template` and configure: `{{BREAD_CRUMB}}{{SUITE_NAME}}/{{TEST_NAME}}` |
83-
| `commit` | Optional. The commit SHA to update the status. This is useful when you run it with `workflow_run`. |
84-
| `fail_on_failure` | Optional. Fail the build in case of a test failure. |
85-
| `require_tests` | Optional. Fail if no test are found. |
86-
| `require_passed_tests` | Optional. Fail if no passed test are found. (This is stricter than `require_tests`, which accepts skipped tests). |
87-
| `include_passed` | Optional. By default the action will skip passed items for the annotations. Enable this flag to include them. |
88-
| `check_retries` | Optional. If a testcase is retried, ignore the original failure. |
89-
| `check_title_template` | Optional. Template to configure the title format. Placeholders: {{FILE_NAME}}, {{SUITE_NAME}}, {{TEST_NAME}}, {{CLASS_NAME}}, {{BREAD_CRUMB}}. |
90-
| `bread_crumb_delimiter` | Optional. Defines the delimiter characters between the breadcrumb elements. Defaults to: `/`. |
91-
| `summary` | Optional. Additional text to summary output |
92-
| `check_annotations` | Optional. Defines if the checks will include annotations. If disabled skips all annotations for the check. (This does not affect `annotate_only`, which uses no checks). |
93-
| `update_check` | Optional. Uses an alternative API to update checks, use for cases with more than 50 annotations. Default: `false`. |
94-
| `annotate_only` | Optional. Will only annotate the results on the files, won't create a check run. Defaults to `false`. |
95-
| `transformers` | Optional. Array of `Transformer`s offering the ability to adjust the fileName. Defaults to: `[{"searchValue":"::","replaceValue":"/"}]` |
96-
| `job_summary` | Optional. Enables the publishing of the job summary for the results. Defaults to `true`. May be required to disable [Enterprise Server](https://github.com/mikepenz/action-junit-report/issues/637) |
97-
| `detailed_summary` | Optional. Include table with all test results in the summary. Defaults to `false`. |
98-
| `flaky_summary` | Optional. Include table with all falky results in the summary. Defaults to `false`. |
99-
| `group_suite` | Optional. If enabled, will group the testcases by test suite in the `detailed_summary`. Defaults to `false`. |
100-
| `comment` | Optional. Enables a comment being added to the PR with the summary tables (Respects the summary configuration flags). Defaults to `false`. |
101-
| `updateComment` | Optional. If a prior action run comment exists, it is updated. If disabled, new comments are creted for each run. Defaults to `true`. |
102-
| `annotate_notice` | Optional. Annotate passed test results along with warning/failed ones. Defaults to `false`. (Changed in v3.5.0) |
103-
| `follow_symlink` | Optional. Enables to follow symlinks when searching test files via the globber. Defaults to `false`. |
104-
| `job_name` | Optional. Specify the name of a check to update |
105-
| `annotations_limit` | Optional. Specify the limit for annotations. This will also interrupt parsing all test-suites if the limit is reached. Defaults to: `No Limit`. |
106-
| `skip_annotations` | Optional. Setting this flag will result in no annotations being added to the run. Defaults to `false`. |
75+
| **Input** | **Description** |
76+
|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
77+
| `report_paths` | Optional. [Glob](https://github.com/actions/toolkit/tree/master/packages/glob) expression to junit report paths. Defaults to: `**/junit-reports/TEST-*.xml`. |
78+
| `token` | Optional. GitHub token for creating a check run. Set to `${{ github.token }}` by default. |
79+
| `test_files_prefix` | Optional. Prepends the provided prefix to test file paths within the report when annotating on GitHub. |
80+
| `exclude_sources` | Optional. Provide `,` seperated array of folders to ignore for source lookup. Defaults to: `/build/,/__pycache__/` |
81+
| `check_name` | Optional. Check name to use when creating a check run. The default is `JUnit Test Report`. |
82+
| `suite_regex` | REMOVED (as of v5). Instead use `check_title_template` and configure: `{{BREAD_CRUMB}}{{SUITE_NAME}}/{{TEST_NAME}}` |
83+
| `commit` | Optional. The commit SHA to update the status. This is useful when you run it with `workflow_run`. |
84+
| `fail_on_failure` | Optional. Fail the build in case of a test failure. |
85+
| `require_tests` | Optional. Fail if no test are found. |
86+
| `require_passed_tests` | Optional. Fail if no passed test are found. (This is stricter than `require_tests`, which accepts skipped tests). |
87+
| `include_passed` | Optional. By default the action will skip passed items for the annotations. Enable this flag to include them. |
88+
| `check_retries` | Optional. If a testcase is retried, ignore the original failure. |
89+
| `check_title_template` | Optional. Template to configure the title format. Placeholders: {{FILE_NAME}}, {{SUITE_NAME}}, {{TEST_NAME}}, {{CLASS_NAME}}, {{BREAD_CRUMB}}. |
90+
| `bread_crumb_delimiter` | Optional. Defines the delimiter characters between the breadcrumb elements. Defaults to: `/`. |
91+
| `summary` | Optional. Additional text to summary output |
92+
| `check_annotations` | Optional. Defines if the checks will include annotations. If disabled skips all annotations for the check. (This does not affect `annotate_only`, which uses no checks). |
93+
| `update_check` | Optional. Uses an alternative API to update checks, use for cases with more than 50 annotations. Default: `false`. |
94+
| `annotate_only` | Optional. Will only annotate the results on the files, won't create a check run. Defaults to `false`. |
95+
| `transformers` | Optional. Array of `Transformer`s offering the ability to adjust the fileName. Defaults to: `[{"searchValue":"::","replaceValue":"/"}]` |
96+
| `job_summary` | Optional. Enables the publishing of the job summary for the results. Defaults to `true`. May be required to disable [Enterprise Server](https://github.com/mikepenz/action-junit-report/issues/637) |
97+
| `detailed_summary` | Optional. Include table with all test results in the summary. Defaults to `false`. |
98+
| `flaky_summary` | Optional. Include table with all falky results in the summary. Defaults to `false`. |
99+
| `group_suite` | Optional. If enabled, will group the testcases by test suite in the `detailed_summary`. Defaults to `false`. |
100+
| `comment` | Optional. Enables a comment being added to the PR with the summary tables (Respects the summary configuration flags). Defaults to `false`. |
101+
| `updateComment` | Optional. If a prior action run comment exists, it is updated. If disabled, new comments are creted for each run. Defaults to `true`. |
102+
| `annotate_notice` | Optional. Annotate passed test results along with warning/failed ones. Defaults to `false`. (Changed in v3.5.0) |
103+
| `follow_symlink` | Optional. Enables to follow symlinks when searching test files via the globber. Defaults to `false`. |
104+
| `job_name` | Optional. Specify the name of a check to update |
105+
| `annotations_limit` | Optional. Specify the limit for annotations. This will also interrupt parsing all test-suites if the limit is reached. Defaults to: `No Limit`. |
106+
| `skip_annotations` | Optional. Setting this flag will result in no annotations being added to the run. Defaults to `false`. |
107+
| `truncate_stack_traces` | Optional. Truncate stack traces from test output to 2 lines in annotations. Defaults to `true`. |
108+
| `resolve_ignore_classname` | Optional. Force ignore test case classname from the xml report (This can help fix issues with some tools/languages). Defaults to `false`. |
107109

108110
### Common Configurations
109111

0 commit comments

Comments
 (0)