1. Resources
  2. /
  3. Plugins
  4. /
  5. plugin-linter-buildkite-plugin

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)

The plugins listed on this webpage are provided for informational purposes only. They have not undergone any formal security review or assessment. While we strive to provide useful resources, we cannot guarantee the safety, reliability, or integrity of these plugins. Users are strongly advised to conduct their own security evaluations before downloading, installing, or using any plugin. By using these plugins, you acknowledge and accept any risks associated with their use. We disclaim any liability for any harm or damages arising from the use of the plugins listed.

Start turning complexity into an advantage

Create an account to get started with a 30-day free trial. No credit card required.

Buildkite Pipelines

Platform

  1. Pipelines
  2. Pipeline templates
  3. Public pipelines
  4. Test Engine
  5. Package Registries
  6. Mobile Delivery Cloud
  7. Pricing

Hosting options

  1. Self-hosted agents
  2. Mac hosted agents
  3. Linux hosted agents

Resources

  1. Docs
  2. Blog
  3. Changelog
  4. Webinars
  5. Plugins
  6. Case studies
  7. Events
  8. Migration Services
  9. Comparisons

Company

  1. About
  2. Careers
  3. Press
  4. Brand assets
  5. Contact

Solutions

  1. Replace Jenkins
  2. Workflows for AI/ML
  3. Testing at scale
  4. Monorepo mojo
  5. Bazel orchestration

Legal

  1. Terms of Service
  2. Acceptable Use Policy
  3. Privacy Policy
  4. Subprocessors
  5. Service Level Agreement

Support

  1. System status
  2. Forum
© Buildkite Pty Ltd 2025