Skip to content

Commit

Permalink
docs: update example plugin usage to show change in plugin behaviour
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremybumsted committed Apr 11, 2024
1 parent 36e5367 commit 0bc6d7e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Here are a few examples of using the plugin to scan within your Buildkite pipeli
```yaml
steps:
- label: "🔎 Scanning with Snyk"
command: "test.sh"
plugins:
- snyk#v0.1.0:
scan: 'oss'
Expand All @@ -52,6 +53,7 @@ steps:
```yaml
steps:
- label: "🔎 Scanning code with Snyk"
command: "test.sh"
plugins:
- snyk#v0.1.0:
scan: 'code'
Expand All @@ -64,6 +66,7 @@ Scanning a docker container image by image name and tag:
```yaml
steps:
- label: "🔎 Scanning container image with Snyk"
command: "build.sh"
plugins:
- snyk#v0.1.0:
scan: 'container'
Expand All @@ -77,6 +80,7 @@ Block a build when a vulnerability is detected:
```yaml
steps:
- label: "🔎 Blocking snyk scan"
command: "test.sh"
plugins:
- snyk#v0.1.0:
scan: 'oss'
Expand All @@ -97,10 +101,6 @@ You can use the [bk cli](https://github.com/buildkite/cli) to run the [pipeline]
bk local run
```

## 👩‍💻 Contributing

Your policy on how to contribute to the plugin!

## 📜 License

The package is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 comments on commit 0bc6d7e

Please sign in to comment.