Skip to content

Commit c866d54

Browse files
Cleaning up doc (#2)
1 parent fd66ffa commit c866d54

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# JUnit Annotate Buildkite Plugin [![Build status](https://badge.buildkite.com/e57701b1037f2c77d0b3f2e4901559ed2e8f131119cd7806ad.svg?branch=master)](https://buildkite.com/buildkite/plugins-junit-annotate)
1+
# JUnit Annotate Buildkite Plugin [![Checks](https://github.com/juandiegopalomino/junit-annotate-local-buildkite-plugin/actions/workflows/ci.yaml/badge.svg)](https://github.com/juandiegopalomino/junit-annotate-local-buildkite-plugin/actions/workflows/ci.yaml)
22

3-
A [Buildkite plugin](https://buildkite.com/docs/agent/v3/plugins) that parses junit.xml artifacts (generated across any number of parallel steps) and creates a [build annotation](https://buildkite.com/docs/agent/v3/cli-annotate) listing the individual tests that failed.
3+
A [Buildkite plugin](https://buildkite.com/docs/agent/v3/plugins) that parses junit.xml from local directories and creates a [build annotation](https://buildkite.com/docs/agent/v3/cli-annotate) listing the individual tests that failed.
44

55
## Example
66

@@ -10,19 +10,16 @@ The following pipeline will run `test.sh` jobs in parallel, and then process all
1010
steps:
1111
- command: test.sh
1212
parallelism: 50
13-
artifact_paths: tmp/junit-*.xml
14-
- wait: ~
15-
continue_on_failure: true
16-
- plugins:
13+
plugins:
1714
- junit-annotate#v2.0.2:
18-
artifacts: tmp/junit-*.xml
15+
directory: tmp
1916
```
2017
2118
## Configuration
2219
23-
### `artifacts` (required)
20+
### `directory` (required)
2421

25-
The artifact glob path to find the JUnit XML files.
22+
The local directory holding the JUnit XML files.
2623

2724
Example: `tmp/junit-*.xml`
2825

0 commit comments

Comments
 (0)