Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update example YAML to use arrays for plugins #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ Shell script linter plugin for Buildkite

[![Build status](https://badge.buildkite.com/c00862681e75d87436590fe047fab7ef179142ebdacd3c40c0.svg?branch=master)](https://buildkite.com/operable/shellcheck-buildkite-plugin)

**NOTE: Plugins only work with the as yet unlreleased 3.0 version of the Buildkite Agent!**

**NOTE: This plugin is a work-in-progress. We use it internally at Operable to test our bundles. However, it may still blow up your systems; use at your own discretion!**

This plugin allows you to lint your shell scripts using [shellcheck](https://github.com/koalaman/shellcheck). It is implememnted in terms of the Docker image for `shellcheck`, so it must be run on a build agent that has access to `docker`.
Expand Down Expand Up @@ -38,22 +36,22 @@ Codes for the warnings can be found in the [shellcheck wiki](https://github.com/
- steps
- label: Simple linting
plugins:
operable/shellcheck:
script: my_script.sh
- operable/shellcheck:
script: my_script.sh

- label: Lint multiple scripts
plugins:
operable/shellcheck:
script:
- my_script.sh
- my_other_script.sh
- yet_another_script.sh
- operable/shellcheck:
script:
- my_script.sh
- my_other_script.sh
- yet_another_script.sh

- label: Exclude some warnings
plugins:
operable/shellcheck:
script: my_script.sh
opts: --exclude=1000
- operable/shellcheck:
script: my_script.sh
opts: --exclude=1000
```

Also see this plugin's [pipeline configuration](.buildkite/pipeline.sh) for other examples.