File tree Expand file tree Collapse file tree 3 files changed +20
-20
lines changed Expand file tree Collapse file tree 3 files changed +20
-20
lines changed Original file line number Diff line number Diff line change 1
1
steps :
2
2
- label : " :bash: Plugin"
3
3
plugins :
4
- docker-compose#v4.9 .0:
5
- run : plugin
4
+ - plugin-tester#v1.0 .0: ~
5
+
6
6
- label : " :ruby: Ruby"
7
7
plugins :
8
- docker-compose#v4.9.0:
9
- run : ruby
8
+ - docker-compose#v4.11.0:
9
+ run : ruby
10
+
10
11
- label : " ✨ Lint"
11
12
plugins :
12
- plugin-linter#v3.0.0:
13
- id : junit-annotate
13
+ - plugin-linter#v3.1.0:
14
+ id : junit-annotate
15
+
14
16
- label : " :bash: Shellcheck"
15
17
plugins :
16
- shellcheck#v1.3.0:
17
- files : hooks/*
18
+ - shellcheck#v1.3.0:
19
+ files : hooks/*
Original file line number Diff line number Diff line change @@ -84,18 +84,22 @@ Default: `ruby:3.1-alpine@sha256:a39e26d0598837f08c75a42c8b0886d9ed5cc862c4b5356
84
84
85
85
# # Developing
86
86
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).
88
88
89
89
` ` ` 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
92
97
` ` `
93
98
94
- To test the Ruby parser locally :
99
+ To test the Ruby code with `rake` in docker :
95
100
96
101
` ` ` bash
97
- cd ruby
98
- rake
102
+ docker-compose run --rm ruby
99
103
` ` `
100
104
101
105
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`.
Original file line number Diff line number Diff line change 1
1
version : ' 2'
2
2
services :
3
- plugin :
4
- image : buildkite/plugin-tester:v4.0.0
5
- volumes :
6
- - " .:/plugin"
7
- depends_on :
8
- - ruby
9
3
ruby :
10
4
image : ruby:3.1-alpine@sha256:a39e26d0598837f08c75a42c8b0886d9ed5cc862c4b535662922ee1d05272fca
11
5
command : rake
You can’t perform that action at this time.
0 commit comments