You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Path to the test results file which will be used to generate
7
+
a report. If this path is provided, it will override the
8
+
execution of all Pester tests, so the **`include_paths`**
9
+
input and all other inputs that drive the test invocation behavior
10
+
will be ignored. Instead a report will be generated based on the
11
+
results stored in the file pointed to by this path.
12
+
At this time, the only test results format supported is the
13
+
NUnit 2.5 Tests results XML schema.
14
+
15
+
test_results_path: # optional
16
+
# Comma-separated list of test full names, or with `-like` wildcards, to restrict which tests are resolved. The default is to include every test discovered matching the other input parameters.
17
+
full_names_filters: # optional
18
+
# Comma-separated list of one or more test files or directories
19
+
that contain test files, relative to the root of the project.
20
+
This path is optional and defaults to the project root,
21
+
in which case all tests script across the entire project tree
22
+
will be discovered. A test script is identified by the
23
+
filename pattern `*.Tests.ps1`.
24
+
This parameter is _ignored_ if the **`test_results_path`**
25
+
parameter is also provided.
26
+
27
+
include_paths: # optional
28
+
# Comma-separated list of one or more test files or directories
29
+
that contain test files, relative to the root of the project,
30
+
that will be excluded from the list fo auto-discovered tests.
31
+
This parameter is _ignored_ if the **`test_results_path`**
32
+
parameter is also provided.
33
+
34
+
exclude_paths: # optional
35
+
# Comma-separated list of tags to include for testing.
36
+
This parameter is _ignored_ if the **`test_results_path`**
37
+
parameter is also provided.
38
+
39
+
include_tags: # optional
40
+
# Comma-separated list of tags to exclude for testing.
41
+
This parameter is _ignored_ if the **`test_results_path`**
42
+
parameter is also provided.
43
+
44
+
exclude_tags: # optional
45
+
# Optionally specify the level of output detail for the test results.
46
+
May be one of: `none`, `Minimal`, `normal`, `detailed`, `diagnostic`
47
+
The default is `normal`.
48
+
49
+
output_level: # optional
50
+
# The name of the report object that will be attached to the
51
+
Workflow Run. Defaults to the name `TEST_RESULTS_<datetime>`
52
+
where `<datetime>` is in the form `yyyyMMdd_hhmmss`.
53
+
54
+
report_name: # optional
55
+
# The title of the report that will be embedded in the report
56
+
itself, which defaults to the same as the `report_name` input.
57
+
58
+
report_title: # optional
59
+
# GITHUB_TOKEN to authenticate against API calls to attach
60
+
report to Workflow Run.
61
+
62
+
github_token: # optional
63
+
# If true, will skip attaching the Tests Result report to
64
+
the Workflow Run using a Check Run. Useful if you just
65
+
want to produce a Gist-based report via the `gist_name`
66
+
and `gist_token` input parameters.
67
+
68
+
skip_check_run: # optional
69
+
# If this value is specifed, the Test Results Report will be
70
+
attached as a version of a Gist under the name of this input.
71
+
The `gist_token` input is also required to use this feature.
72
+
73
+
gist_name: # optional
74
+
# If specified, the Test Report Gist will also include an adjacent
75
+
badge rendered with the status of the associated Test Report and
76
+
and label content of this input. In addition to any static text
77
+
you can provide _escape tokens_ of the form `%name%` where name
78
+
can be the name of any field returned from a Pester Result, such
79
+
as `ExecutedAt` or `Result`. If you want a literal percent, just
80
+
specify an empty name as in `%%`.
81
+
82
+
gist_badge_label: # optional
83
+
# If Gist badge generation is enabled by providing a value for the
84
+
`gist_badge_label`input, this input allows you to override the
85
+
default message on the badge, which is equivalent to the the
86
+
Pester Result `Status` such as `Failed` or `Passed`. As with the
87
+
label input, you can specify escape tokens in addition to literal
88
+
text. See the label input description for more details.
89
+
90
+
gist_badge_message: # optional
91
+
# GitHub OAuth/PAT token to be used for accessing Gist to store
92
+
test results report. The integrated GITHUB_TOKEN that is normally
93
+
accessible during a Workflow does not include read/write permissions
94
+
to associated Gists, therefore a separate token is needed.
95
+
You can control which account is used to actually store the state by
96
+
generating a token associated with the target account.
97
+
98
+
gist_token: # optional
99
+
# Comma-separated list of one or more directories to scan for code
100
+
coverage, relative to the root of the project. Will include all .ps1
101
+
and .psm1 files under these directories recursively.
102
+
103
+
coverage_paths: # optional
104
+
# The name of the code coverage report object that will be attached
105
+
to the Workflow Run. Defaults to the name
106
+
`COVERAGE_RESULTS_<datetime>`where `<datetime>` is in the form
107
+
`yyyyMMdd_hhmmss`.
108
+
109
+
coverage_report_name: # optional
110
+
# The title of the code coverage report that will be embedded in the
111
+
report itself, which defaults to the same as the
112
+
`code_coverage_report_name`input.
113
+
114
+
coverage_report_title: # optional
115
+
# If true, will attach the coverage results to the gist specified in
116
+
`gist_name`.
117
+
118
+
coverage_gist: # optional
119
+
# If specified, the Test Report Gist will also include an adjacent
120
+
badge rendered with the percentage of the associated Coverage Report
121
+
and label content of this input.
122
+
123
+
coverage_gist_badge_label: # optional
124
+
# If true, will cause the step to fail if one or more tests fails.
0 commit comments