Skip to content

Commit 826ae5d

Browse files
committed
Update documentation on how oto run the tests
1 parent 0e7e672 commit 826ae5d

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,18 +84,22 @@ Default: `ruby:3.1-alpine@sha256:a39e26d0598837f08c75a42c8b0886d9ed5cc862c4b5356
8484

8585
## Developing
8686

87-
To test the plugin hooks (in Bash) and the junit parser (in Ruby):
87+
To run testing, shellchecks and plugin linting use use `bk run` with the [Buildkite CLI](https://github.com/buildkite/cli).
8888

8989
```bash
90-
docker-compose run --rm plugin &&
91-
docker-compose run --rm ruby
90+
bk run
91+
```
92+
93+
Or if you want to run just the plugin tests, you can use the docker [Plugin Tester](https://github.com/buildkite-plugins/buildkite-plugin-tester):
94+
95+
```bash
96+
docker run --rm -ti -v "${PWD}":/plugin buildkite/plugin-tester:latest
9297
```
9398

94-
To test the Ruby parser locally:
99+
To test the Ruby code with `rake` in docker:
95100

96101
```bash
97-
cd ruby
98-
rake
102+
docker-compose run --rm ruby
99103
```
100104

101105
To test your plugin in your builds prior to opening a pull request, you can refer to your fork and SHA from a branch in your `pipeline.yml`.

0 commit comments

Comments
 (0)