1
0
mirror of https://github.com/stackrox/kube-linter-action.git synced 2026-07-04 23:51:37 +00:00

Update README.md

Fixing for update to versioning.
This commit is contained in:
neilcar
2020-12-02 18:25:45 -05:00
committed by GitHub
parent 78b632e41f
commit f2c260fad1
+2 -4
View File
@@ -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.
* `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.