Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 1.68 KB

README.md

File metadata and controls

59 lines (35 loc) · 1.68 KB
Raw

Plugin Linter Buildkite Plugin Build status

A Buildkite plugin to lint your Buildkite plugins 😱

For a full list of features see the Buildkite Plugin Linter cli tool documentation.

Usage

steps:
  - label: ":sparkles: Lint"
    plugins:
      - plugin-linter#v3.3.0:
          id: my-org/my-plugin

Note: this will pull the latest version of the Plugin Linter each time it is run.

If you want to run it locally on a command line, see the Buildkite Plugin Linter cli tool documentation.

Configuration

Required

id

The id of the plugin (e.g. my-org/my-plugin)

Optional

image-version

The docker tag of the buildkite/plugin-linter image to use. Default is 2.0.3

readme

The filename of the plugin’s readme to lint examples on. Default is README.md

skip-invalid (boolean)

Whether invalid examples (for example with invalid options) should not cause the linting to fail. Defaults to false.

Developing

To run testing, shellchecks and plugin linting use use bk run with the Buildkite CLI.

bk run

Or if you want to run just the tests, you can use the docker Plugin Tester:

docker run --rm -ti -v "${PWD}":/plugin buildkite/plugin-tester:latest

License

MIT (see LICENSE)