Skip to content

Commit cf652a6

Browse files
authored
Merge pull request #259 from buildkite-plugins/bm/compat_table
Add compatibility table to README
2 parents 906eeb6 + 0ebf241 commit cf652a6

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ steps:
1414
- wait: ~
1515
continue_on_failure: true
1616
- plugins:
17-
- junit-annotate#v2.6.0:
17+
- junit-annotate#v2.7.0:
1818
artifacts: tmp/junit-*.xml
1919
```
2020
@@ -30,10 +30,10 @@ steps:
3030
- wait: ~
3131
continue_on_failure: true
3232
- plugins:
33-
- junit-annotate#v2.6.0:
33+
- junit-annotate#v2.7.0:
3434
artifacts: tmp/junit-*.xml
3535
- plugins:
36-
- junit-annotate#v2.6.0:
36+
- junit-annotate#v2.7.0:
3737
artifacts: artifacts/junit-*.xml
3838
context: junit-artifacts
3939
```
@@ -114,6 +114,17 @@ Default: `true`
114114

115115
Controls whether the JUnit processing should run inside a Docker container. When set to `false`, the processing will run directly on the host using the system's Ruby installation.
116116

117+
## Compatibility
118+
119+
| Elastic Stack | Agent Stack K8s | Hosted (Mac) | Hosted (Linux) | Notes |
120+
| :-----------: | :-------------: | :----: | :----: |:---- |
121+
| ✅ | ⚠️ | ⚠️ | ✅ | **K8s** - Out of the box, requires `run-in-docker: false` and a container image with `ruby` installed<br>Likely requires some complex podSpec (pending investigation)<br>**Hosted (Mac)** - instances do not ship with the Docker daemon, but can use a `ruby` binary on the agent |
122+
123+
- ✅ Fully supported (all combinations of attributes have been tested to pass)
124+
- ⚠️ Partially supported (some combinations cause errors/issues)
125+
- ❌ Not supported
126+
127+
117128
## Developing
118129

119130
To run testing, shellchecks and plugin linting use use `bk run` with the [Buildkite CLI](https://github.com/buildkite/cli).
@@ -140,7 +151,7 @@ To test your plugin in your builds prior to opening a pull request, you can refe
140151
steps:
141152
- label: Annotate
142153
plugins:
143-
- YourGithubHandle/junit-annotate#v2.6.0:
154+
- YourGithubHandle/junit-annotate#v2.7.0:
144155
...
145156
```
146157

0 commit comments

Comments
 (0)