Plugin Tester BuildKite Plugin

A Buildkite plugin that runs plugin tests (using the specially-built docker image)

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 to run. Default: v4.2.0.

Examples

99% of the time you will have to use the following step verbatim:

steps:
  - label: "🔨 Tests"
    plugins:
      - plugin-tester#v1.2.0: ~

Multiple folders

If you have a sub-folder with tests, you will need to specify both folders (unfortunately):

steps:
  - label: "🔨 Running tests"
    plugins:
      - plugin-tester#v1.2.0:
          folders:
            - tests
            - tests/v2

⚒ Developing

You can use the bk cli to run the pipeline locally:

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.