https://github.com/buildkite-plugins/plugin-tester-buildkite-plugin
☑️ Buildkite plugin to test plugins
https://github.com/buildkite-plugins/plugin-tester-buildkite-plugin
buildkite-plugin test-plugin
Last synced: 17 days ago
JSON representation
☑️ Buildkite plugin to test plugins
- Host: GitHub
- URL: https://github.com/buildkite-plugins/plugin-tester-buildkite-plugin
- Owner: buildkite-plugins
- License: mit
- Created: 2023-03-11T18:01:59.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-07-07T17:31:28.000Z (11 months ago)
- Last Synced: 2025-07-07T18:49:56.985Z (11 months ago)
- Topics: buildkite-plugin, test-plugin
- Language: Shell
- Homepage:
- Size: 35.2 KB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Plugin Tester BuildKite Plugin [](https://buildkite.com/buildkite/plugins-plugin-tester)
A Buildkite plugin that runs plugin tests (using the [specially-built docker image](https://github.com/buildkite-plugins/buildkite-plugin-tester))
## Options
These are all the options available to configure this plugin's behaviour.
### Required
There are no mandatory options.
### Optional
#### `folders` (string or array)
The folders that contain the tests to run. You will need to use this option if you have more than one folder with tests. Default: `tests`.
#### `pull` (boolean)
Whether to force pulling the image before running or not. Default: `false`.
#### `version` (string)
The version of the [plugin tester docker image](https://github.com/buildkite-plugins/buildkite-plugin-tester) to run. Default: `v4.3.0`.
## Examples
99% of the time you will have to use the following step verbatim:
```yaml
steps:
- label: "🔨 Tests"
plugins:
- plugin-tester#v1.3.0: ~
```
## Multiple folders
If you have a sub-folder with tests, you will need to specify both folders (unfortunately):
```yaml
steps:
- label: "🔨 Running tests"
plugins:
- plugin-tester#v1.3.0:
folders:
- tests
- tests/v2
```
## ⚒ Developing
You can use the [bk cli](https://github.com/buildkite/cli) to run the [pipeline](.buildkite/pipeline.yml) locally:
```bash
bk local run
```
## 👩💻 Contributing
Feel free to open PRs with functionality or report issues here in GitHub :)
## 📜 License
The package is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).