README.md

Shellcheck Buildkite Plugin

A Buildkite plugin that runs shellcheck against your shell scripts using the koalaman/shellcheck docker image.

Example

This will check all shellscripts with shellcheck.

steps:
  - plugins:
      - shellcheck#v1.4.0:
          files: scripts/*.sh

Configuration

Required

files (string or array of strings)

The files (or globs) to run shellcheck on.

Optional

extended_glob (boolean)

Enable using extended glob patterns, e.g. *.+(sh|bash)

Default: false

recursive_glob (boolean)

Enable using recursive globbing, e.g. **/*.sh

Note: requires at least Bash 4 on the Buildkite Agent

Default: false

options (string or array of strings)

Command line options to pass to shellcheck.

Default: "--color=always"

version (string)

Version of docker image to use.

Default: latest

image (string)

Which shell check image to use.

Default: koalaman/shellcheck

Developing

To run the tests:

docker-compose run --rm tests bats tests

License

MIT (see LICENSE)