From 82545eca0e4bd9ac3c859154281c887aa5dfbb58 Mon Sep 17 00:00:00 2001 From: Olivier Halligon Date: Tue, 17 May 2022 12:13:57 +0200 Subject: [PATCH] Add documentation for integrating shellcheck with Buildkite --- Buildkite.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 Buildkite.md diff --git a/Buildkite.md b/Buildkite.md new file mode 100644 index 0000000..5008b2b --- /dev/null +++ b/Buildkite.md @@ -0,0 +1,14 @@ +Buildkite provides [a plugin dedicated to run `shellcheck`](https://github.com/buildkite-plugins/shellcheck-buildkite-plugin). + +Simply add this step to your Buildkite pipeline (`.buildkite/pipeline.yml`) to use it: + +```yaml +steps: + - label: ":shell: Shellcheck" + plugins: + shellcheck#v1.1.2: + # List the files you want to lint + files: ["**/*.sh"] + # additional options to pass to shellcheck (optional) + options: ["-x", "-P", "SCRIPTDIR"] +```