Skip to content

Commit 9f362b5

Browse files
mikepenzmikepenz
authored
Merge pull request #1366 from mikepenz/feature/1365
User server url from `github.context`
2 parents 65fe035 + 05a4fbe commit 9f362b5

File tree

4 files changed

+47
-47
lines changed

4 files changed

+47
-47
lines changed

‎README.md

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -72,48 +72,48 @@ 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-
| `group_reports` | Optional. Defines if different reports found by a single `report_paths` glob expression are grouped together. Defaults to `true`. |
80-
| `test_files_prefix` | Optional. Prepends the provided prefix to test file paths within the report when annotating on GitHub. |
81-
| `exclude_sources` | Optional. Provide `,` seperated array of folders to ignore for source lookup. Defaults to: `/build/,/__pycache__/` |
82-
| `check_name` | Optional. Check name to use when creating a check run. The default is `JUnit Test Report`. |
83-
| `suite_regex` | REMOVED (as of v5). Instead use `check_title_template` and configure: `{{BREAD_CRUMB}}{{SUITE_NAME}}/{{TEST_NAME}}` |
84-
| `commit` | Optional. The commit SHA to update the status. This is useful when you run it with `workflow_run`. |
85-
| `fail_on_failure` | Optional. Fail the build in case of a test failure. |
86-
| `fail_on_parse_error` | Optional. Fail the build if the test report file cannot be parsed. |
87-
| `require_tests` | Optional. Fail if no test are found. |
88-
| `require_passed_tests` | Optional. Fail if no passed test are found. (This is stricter than `require_tests`, which accepts skipped tests). |
89-
| `include_passed` | Optional. By default the action will skip passed items for the annotations. Enable this flag to include them. |
90-
| `check_retries` | Optional. If a testcase is retried, ignore the original failure. |
91-
| `check_title_template` | Optional. Template to configure the title format. Placeholders: {{FILE_NAME}}, {{SUITE_NAME}}, {{TEST_NAME}}, {{CLASS_NAME}}, {{BREAD_CRUMB}}. |
92-
| `bread_crumb_delimiter` | Optional. Defines the delimiter characters between the breadcrumb elements. Defaults to: `/`. |
93-
| `summary` | Optional. Additional text to summary output |
94-
| `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). |
95-
| `update_check` | Optional. Uses an alternative API to update checks, use for cases with more than 50 annotations. Default: `false`. |
96-
| `annotate_only` | Optional. Will only annotate the results on the files, won't create a check run. Defaults to `false`. |
97-
| `transformers` | Optional. Array of `Transformer`s offering the ability to adjust the fileName. Defaults to: `[{"searchValue":"::","replaceValue":"/"}]` |
98-
| `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) |
99-
| `detailed_summary` | Optional. Include table with all test results in the summary (Also applies to comment). Defaults to `false`. |
100-
| `flaky_summary` | Optional. Include table with all flaky results in the summary (Also applies to comment). Defaults to `false`. |
101-
| `verbose_summary` | Optional. Detail table will note if there were no test annotations for a test suite (Also applies to comment). Defaults to `true`. |
102-
| `skip_success_summary` | Optional. Skips the summary table if only successful tests were detected (Also applies to comment). Defaults to `false`. |
103-
| `include_empty_in_summary` | Optional. Include entries in summaries that have 0 count. Defaults to `true`. |
104-
| `include_time_in_summary` | Optional. Include spent time in summaries. Defaults to `false`. |
105-
| `simplified_summary` | Optional. Use icons instead of text to indicate status in summary. Defaults to `false`. |
106-
| `group_suite` | Optional. If enabled, will group the testcases by test suite in the `detailed_summary`. Defaults to `false`. |
107-
| `comment` | Optional. Enables a comment being added to the PR with the summary tables (Respects the summary configuration flags). Defaults to `false`. |
108-
| `updateComment` | Optional. If a prior action run comment exists, it is updated. If disabled, new comments are creted for each run. Defaults to `true`. |
109-
| `annotate_notice` | Optional. Annotate passed test results along with warning/failed ones. Defaults to `false`. (Changed in v3.5.0) |
110-
| `follow_symlink` | Optional. Enables to follow symlinks when searching test files via the globber. Defaults to `false`. |
111-
| `job_name` | Optional. Specify the name of a check to update |
112-
| `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`. |
113-
| `skip_annotations` | Optional. Setting this flag will result in no annotations being added to the run. Defaults to `false`. |
114-
| `truncate_stack_traces` | Optional. Truncate stack traces from test output to 2 lines in annotations. Defaults to `true`. |
115-
| `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`. |
116-
| `skip_comment_without_tests` | Optional. Disable commenting if no tests are detected. 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+
| `group_reports` | Optional. Defines if different reports found by a single `report_paths` glob expression are grouped together. Defaults to `true`. |
80+
| `test_files_prefix` | Optional. Prepends the provided prefix to test file paths within the report when annotating on GitHub. |
81+
| `exclude_sources` | Optional. Provide `,` seperated array of folders to ignore for source lookup. Defaults to: `/build/,/__pycache__/` |
82+
| `check_name` | Optional. Check name to use when creating a check run. The default is `JUnit Test Report`. |
83+
| `suite_regex` | REMOVED (as of v5). Instead use `check_title_template` and configure: `{{BREAD_CRUMB}}{{SUITE_NAME}}/{{TEST_NAME}}` |
84+
| `commit` | Optional. The commit SHA to update the status. This is useful when you run it with `workflow_run`. |
85+
| `fail_on_failure` | Optional. Fail the build in case of a test failure. |
86+
| `fail_on_parse_error` | Optional. Fail the build if the test report file cannot be parsed. |
87+
| `require_tests` | Optional. Fail if no test are found. |
88+
| `require_passed_tests` | Optional. Fail if no passed test are found. (This is stricter than `require_tests`, which accepts skipped tests). |
89+
| `include_passed` | Optional. By default the action will skip passed items for the annotations. Enable this flag to include them. |
90+
| `check_retries` | Optional. If a testcase is retried, ignore the original failure. |
91+
| `check_title_template` | Optional. Template to configure the title format. Placeholders: {{FILE_NAME}}, {{SUITE_NAME}}, {{TEST_NAME}}, {{CLASS_NAME}}, {{BREAD_CRUMB}}. |
92+
| `bread_crumb_delimiter` | Optional. Defines the delimiter characters between the breadcrumb elements. Defaults to: `/`. |
93+
| `summary` | Optional. Additional text to summary output |
94+
| `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). |
95+
| `update_check` | Optional. Uses an alternative API to update checks, use for cases with more than 50 annotations. Default: `false`. |
96+
| `annotate_only` | Optional. Will only annotate the results on the files, won't create a check run. Defaults to `false`. |
97+
| `transformers` | Optional. Array of `Transformer`s offering the ability to adjust the fileName. Defaults to: `[{"searchValue":"::","replaceValue":"/"}]` |
98+
| `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) |
99+
| `detailed_summary` | Optional. Include table with all test results in the summary (Also applies to comment). Defaults to `false`. |
100+
| `flaky_summary` | Optional. Include table with all flaky results in the summary (Also applies to comment). Defaults to `false`. |
101+
| `verbose_summary` | Optional. Detail table will note if there were no test annotations for a test suite (Also applies to comment). Defaults to `true`. |
102+
| `skip_success_summary` | Optional. Skips the summary table if only successful tests were detected (Also applies to comment). Defaults to `false`. |
103+
| `include_empty_in_summary` | Optional. Include entries in summaries that have 0 count. Defaults to `true`. |
104+
| `include_time_in_summary` | Optional. Include spent time in summaries. Defaults to `false`. |
105+
| `simplified_summary` | Optional. Use icons instead of text to indicate status in summary. Defaults to `false`. |
106+
| `group_suite` | Optional. If enabled, will group the testcases by test suite in the `detailed_summary`. Defaults to `false`. |
107+
| `comment` | Optional. Enables a comment being added to the PR with the summary tables (Respects the summary configuration flags). Defaults to `false`. |
108+
| `updateComment` | Optional. If a prior action run comment exists, it is updated. If disabled, new comments are creted for each run. Defaults to `true`. |
109+
| `annotate_notice` | Optional. Annotate passed test results along with warning/failed ones. Defaults to `false`. (Changed in v3.5.0) |
110+
| `follow_symlink` | Optional. Enables to follow symlinks when searching test files via the globber. Defaults to `false`. |
111+
| `job_name` | Optional. Specify the name of a check to update |
112+
| `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`. |
113+
| `skip_annotations` | Optional. Setting this flag will result in no annotations being added to the run. Defaults to `false`. |
114+
| `truncate_stack_traces` | Optional. Truncate stack traces from test output to 2 lines in annotations. Defaults to `true`. |
115+
| `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`. |
116+
| `skip_comment_without_tests` | Optional. Disable commenting if no tests are detected. Defaults to `false`. |
117117

118118
### Common Configurations
119119

0 commit comments

Comments
 (0)