Skip to content

Commit 660bde7

Browse files
committed
Documented new option
1 parent 132401a commit 660bde7

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The buildkite annotation context to use. Useful to differentiate multiple runs o
4040

4141
Default: `-(.*).xml`
4242

43-
The regular expression (with capture group) that matches the job UUID in the junit file names. This is used to create the job links in the annotation.
43+
The regular expression (with capture group) that matches the job UUID in the junit file names. This is used to create the job links in the annotation.
4444

4545
To use this, configure your test reporter to embed the `$BUILDKITE_JOB_ID` environment variable into your junit file names. For example `"junit-buildkite-job-$BUILDKITE_JOB_ID.xml"`.
4646

@@ -54,7 +54,7 @@ There are two options for this:
5454
* `file`
5555
* displays: `MyClass::UnderTest text of the failed expectation in path/to/my_class/under_test.file_ext`
5656

57-
### `fail-build-on-error` (optional)
57+
### `fail-build-on-error` (optional)
5858

5959
Default: `false`
6060

@@ -70,6 +70,12 @@ Exit code of the plugin if the call to `buildkite-agent artifact download` fails
7070

7171
Minimum amount of run tests that need to be analyzed or a failure will be reported. It is useful to ensure that tests are actually run and report files to analyze do contain information.
7272

73+
### `report-skipped` (optional, boolean)
74+
75+
Default: `false`
76+
77+
Will add a list of skipped tests at the end of the annotation. Note that even if there are skipped tests, the annotation may not be added unless other options or results of the processing forces it to.
78+
7379
### `report-slowest` (optional)
7480

7581
Default: `0`

plugin.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ configuration:
2424
type: string
2525
min-tests:
2626
type: integer
27+
report-skipped:
28+
type: boolean
2729
report-slowest:
2830
type: integer
2931
ruby-image:

0 commit comments

Comments
 (0)