/
action.yml
156 lines (152 loc) · 8.98 KB
/
action.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
name: 'Publish Test Results'
author: 'EnricoMi'
description: 'Publishes JUnit, NUnit, XUnit, TRX, JSON test results on GitHub for .NET, Dart, Java, JS, Jest, Mocha, Python, Scala, …'
inputs:
github_token:
description: 'GitHub API Access Token.'
default: ${{ github.token }}
required: false
github_token_actor:
description: 'The name of the GitHub app that owns the GitHub API Access Token (see github_token). Used to identify pull request comments created by this action during earlier runs. Has to be set when `github_token` is set to a GitHub app installation token (other than GitHub actions). Otherwise, existing comments will not be updated, but new comments created. Note: this does not change the bot name of the pull request comments. Defaults to "github-actions".'
default: 'github-actions'
required: false
github_retries:
description: 'Requests to the GitHub API are retried this number of times. The value must be a positive integer or zero.'
default: '10'
required: false
commit:
description: 'Commit SHA to which test results are published. Only needed if the value of GITHUB_SHA does not work for you.'
required: false
check_name:
description: 'Name of the created check run.'
default: 'Test Results'
required: false
comment_title:
description: 'An alternative title for the pull request comment. Defaults to value of check_name input.'
required: false
comment_mode:
description: 'The action posts comments to pull requests that are associated with the commit. Set to "always" - always comment, "changes" - comment when changes w.r.t. the target branch exist, "changes in failures" - when changes in the number of failures and errors exist, "changes in errors" - when changes in the number of (only) errors exist, "failures" - when failures or errors exist, "errors" - when (only) errors exist, "off" - to not create pull request comments.'
default: 'always'
required: false
fail_on:
description: 'The created test result check run has failure state if any test fails or test errors occur. Never fails when set to "nothing", fails only on errors when set to "errors". Default is "test failures".'
default: 'test failures'
required: false
action_fail:
description: 'When set "true", the action itself fails when tests have failed (see option fail_on).'
default: 'false'
required: false
action_fail_on_inconclusive:
description: 'When set "true", the action itself fails when tests are inconclusive (no test results).'
default: 'false'
required: false
files:
description: 'File patterns of test result files. Relative paths are known to work best, while the non-Docker action also works with absolute paths. Supports "*", "**", "?", and "[]" character ranges. Use multiline string for multiple patterns. Patterns starting with "!" exclude the matching files. There have to be at least one pattern starting without a "!".'
required: false
junit_files:
description: 'Deprecated, use "files" option instead.'
required: false
nunit_files:
description: 'Deprecated, use "files" option instead.'
required: false
xunit_files:
description: 'Deprecated, use "files" option instead.'
required: false
trx_files:
description: 'Deprecated, use "files" option instead.'
required: false
time_unit:
description: 'Time values in the test result files have this unit. Supports "seconds" and "milliseconds".'
default: 'seconds'
required: false
test_file_prefix:
description: 'Paths in the test result files should be relative to the git repository for annotations to work best. This prefix is added to (if starting with "+"), or remove from (if starting with "-") test file paths. Examples: "+src/" or "-/opt/actions-runner".'
required: false
report_individual_runs:
description: 'Individual runs of the same test may see different failures. Reports all individual failures when set "true" or the first only otherwise.'
required: false
report_suite_logs:
description: 'In addition to reporting regular test logs, also report test suite logs. These are logs provided on suite level, not individual test level. Set to "info" for normal output, "error" for error output, "any" for both, or "none" for no suite logs at all. Defaults to "none".'
default: 'none'
required: false
deduplicate_classes_by_file_name:
description: 'De-duplicates classes with same name by their file name when set "true", combines test results for those classes otherwise.'
required: false
large_files:
description: 'Support for large files is enabled when set to "true". Defaults to "false", unless ignore_runs is "true".'
required: false
ignore_runs:
description: 'Does not collect test run information from the test result files, which is useful for very large files. This disables any check run annotations.'
default: 'false'
required: false
check_run:
description: 'Set to "true", the results are published as a check run, but it may not be associated with the workflow that ran this action.'
default: 'true'
required: false
job_summary:
description: 'Set to "true", the results are published as part of the job summary page of the workflow run.'
default: 'true'
required: false
compare_to_earlier_commit:
description: 'Test results are compared to results of earlier commits to highlight changes: "false" - disable comparison, "true" - compare across commits.'
default: 'true'
required: false
pull_request_build:
description: 'As part of pull requests, GitHub builds a merge commit, which combines the commit and the target branch. If tests ran on the actual pushed commit, then set this to "commit". Defaults to "merge".'
default: 'merge'
required: false
event_file:
description: 'An alternative event file to use. Useful to replace a "workflow_run" event file with the actual source event file.'
required: false
event_name:
description: 'An alternative event name to use. Useful to replace a "workflow_run" event name with the actual source event name: github.event.workflow_run.event.'
required: false
test_changes_limit:
description: 'Limits the number of removed or skipped tests reported on pull request comments. This report can be disabled with a value of 0. The default is 10.'
required: false
check_run_annotations:
description: 'Adds additional information to the check run. This is a comma-separated list of any of the following values: "all tests" - list all found tests, "skipped tests" - list all skipped tests. Set to "none" to add no extra annotations at all.'
default: 'all tests, skipped tests'
required: false
check_run_annotations_branch:
description: 'Adds check run annotations only on given branches. Comma-separated list of branch names allowed, asterisk "*" matches all branches. Defaults to event.repository.default_branch or "main, master".'
required: false
seconds_between_github_reads:
description: 'Sets the number of seconds the action waits between concurrent read requests to the GitHub API. This throttles the API usage to avoid abuse rate limits: https://docs.github.com/en/rest/overview/resources-in-the-rest-api#abuse-rate-limits.'
default: '0.25'
required: false
seconds_between_github_writes:
description: 'Sets the number of seconds the action waits between concurrent write requests to the GitHub API. This throttles the API usage to avoid abuse rate limits: https://docs.github.com/en/rest/overview/resources-in-the-rest-api#abuse-rate-limits.'
default: '2.0'
required: false
secondary_rate_limit_wait_seconds:
description: 'Sets the number of seconds to wait before retrying secondary rate limit errors. If not set, the default defined in the PyGithub library is used (currently 60 seconds).'
required: false
json_file:
description: 'Results are written to this JSON file.'
required: false
json_thousands_separator:
description: 'Formatted numbers in JSON use this character to separate groups of thousands. Common values are "," or ".". Defaults to punctuation space (\u2008).'
default: ' '
required: false
json_suite_details:
description: 'Write out all suite details to the JSON file. Setting this to "true" can greatly increase the size of the output. Defaults to "false".'
default: 'false'
required: false
json_test_case_results:
description: 'Write out all individual test case results to the JSON file. Setting this to "true" can greatly increase the size of the output. Defaults to "false".'
default: 'false'
required: false
search_pull_requests:
description: 'Prior to v2.6.0, the action used the "/search/issues" REST API to find pull requests related to a commit. If you need to restore that behaviour, set this to "true". Defaults to "false".'
default: 'false'
required: false
outputs:
json:
description: "Test results as JSON"
runs:
using: 'docker'
image: 'docker://ghcr.io/enricomi/publish-unit-test-result-action:v2.16.1'
branding:
icon: 'check-circle'
color: 'green'