Skip to content

Commit 1733543

Browse files
committed
Added documentation on new option (and tweaked the rest)
1 parent 6ad3d32 commit 1733543

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,37 +30,42 @@ Example: `tmp/junit-*.xml`
3030

3131
Forces the creation of the annotation even when no failures or errors are found
3232

33+
### `context` (optional)
34+
35+
Default: `junit`
36+
37+
The buildkite annotation context to use. Useful to differentiate multiple runs of this plugin in a single pipeline.
38+
3339
### `job-uuid-file-pattern` (optional)
40+
3441
Default: `-(.*).xml`
3542

36-
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.
3744

3845
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"`.
3946

4047
### `failure-format` (optional)
41-
Default: `classname`
4248

4349
This setting controls the format of your failed test in the main annotation summary.
4450

4551
There are two options for this:
46-
* `classname`
52+
* `classname` (the default)
4753
* displays: `MyClass::UnderTest text of the failed expectation in path.to.my_class.under_test`
4854
* `file`
4955
* displays: `MyClass::UnderTest text of the failed expectation in path/to/my_class/under_test.file_ext`
5056

5157
### `fail-build-on-error` (optional)
58+
5259
Default: `false`
5360

54-
If this setting is true and any errors are found in the JUnit XML files during
55-
parsing, the annotation step will exit with a non-zero value, which should cause
56-
the build to fail.
61+
If this setting is true and any errors are found in the JUnit XML files during parsing, the annotation step will exit with a non-zero value, which should cause the build to fail.
5762

58-
### `context` (optional)
59-
Default: `junit`
63+
### `min-tests` (optional, integer)
6064

61-
The buildkite annotation context to use. Useful to differentiate multiple runs of this plugin in a single pipeline.
65+
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.
6266

6367
### `report-slowest` (optional)
68+
6469
Default: `0`
6570

6671
Include the specified number of slowest tests in the annotation. The annotation will always be shown.

0 commit comments

Comments
 (0)