Merge pull request #59 from buildkite-plugins/toote_skip_invalid

New `skip-invalid` option

Author: pzeballos

README.md

@@ -10,7 +10,7 @@ For a full list of features see the [Buildkite Plugin Linter cli tool documentat
 steps:
   - label: ":sparkles: Lint"
     plugins:
-      - plugin-linter#v3.2.0:
+      - plugin-linter#v3.3.0:
           id: my-org/my-plugin
 ```
 
@@ -20,17 +20,25 @@ If you want to run it locally on a command line, see the [Buildkite Plugin Linte
 
 ## Configuration
 
-### `id`
+### Required
+
+#### `id`
 
 The id of the plugin (e.g. `my-org/my-plugin`)
 
-### `image-version`
+### Optional
+
+#### `image-version`
 
 The docker tag of the `buildkite/plugin-linter` image to use. Default is `2.0.3`
 
-### `readme` (optional)
+#### `readme`
+
+The filename of the plugin’s readme to lint examples on. Default is `README.md`
+
+#### `skip-invalid` (boolean)
 
-The filename of the plugin’s readme. Default is `README.md`
+Whether invalid examples (for example with invalid options) should not cause the linting to fail. Defaults to false.
 
 ## Developing
 

hooks/command

@@ -26,4 +26,8 @@ if [[ -n "${BUILDKITE_PLUGIN_PLUGIN_LINTER_README:-}" ]] ; then
   args+=("--env" "PLUGIN_README=$BUILDKITE_PLUGIN_PLUGIN_LINTER_README")
 fi
 
+if [[ -n "${BUILDKITE_PLUGIN_PLUGIN_LINTER_SKIP_INVALID:-}" ]] ; then
+  args+=("--env" "PLUGIN_SKIP_INVALID=$BUILDKITE_PLUGIN_PLUGIN_LINTER_SKIP_INVALID")
+fi
+
 docker run "${args[@]}" buildkite/plugin-linter:"${TAG}"

plugin.yml

@@ -11,6 +11,8 @@ configuration:
       type: string
     readme:
       type: string
+    skip-invalid:
+      type: boolean
   required:
     - id
   additionalProperties: false

tests/command.bats

@@ -48,6 +48,22 @@ setup() {
   unstub docker
 }
 
+
+@test "Supports the skip-invalid option" {
+  export BUILDKITE_PLUGIN_PLUGIN_LINTER_SKIP_INVALID=true
+
+  stub docker \
+    "pull buildkite/plugin-linter:latest : echo pulled image" \
+    "run -it --rm --volume /plugin:/plugin:ro --env PLUGIN_ID=my-plugin --env PLUGIN_SKIP_INVALID=true buildkite/plugin-linter:latest : echo linted"
+
+  run "$PWD"/hooks/command
+
+  assert_success
+  assert_output --partial "pulled image"
+  assert_output --partial "linted"
+  unstub docker
+}
+
 @test "Support not specifying a tag" {
   unset BUILDKITE_PLUGIN_PLUGIN_LINTER_IMAGE_VERSION