diff --git a/README.md b/README.md index ee6a9ef..2427abf 100755 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # kube-linter-action -# kube-linter-action GitHub action - This is a GitHub action for scanning Kubernetes deployment files with [kube-linter](https://github.com/stackrox/kube-linter). This includes both the action itself (.github/actions) and sample GitHub workflow (.github/workflows) and a test YAML. Quick deployment: @@ -15,11 +13,11 @@ The action takes two parameters. ``` - name: Scan repo id: kube-lint-repo - uses: stackrox/kube-linter-action@v0.0.1 + uses: stackrox/kube-linter-action@v1 with: directory: yamls config: .kube-linter/config.yaml ``` * `directory` is mandatory -- this is the directory of deployment files to scan. -* `config` is optional -- this is the path to a [configuration file](https://github.com/stackrox/kube-linter/blob/main/config.yaml.example) if you wish to use a non-default configuration. \ No newline at end of file +* `config` is optional -- this is the path to a [configuration file](https://github.com/stackrox/kube-linter/blob/main/config.yaml.example) if you wish to use a non-default configuration.