Skip to content

Commit 2b17b6e

Browse files
committedOct 30, 2019
Added instructions for Helm Action
1 parent 9f2d968 commit 2b17b6e

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed
 

‎README.md

+35
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,38 @@ passed to the action using `with`, as demonstrated with `files` in the above exa
2727
| policy | policy | Where to find the policy folder or files |
2828
| namespace | main | The Rego namespace to use for testing |
2929
| output | stdout | How to format the output from Conftest (stdout, json or tap) |
30+
31+
32+
## Helm
33+
34+
Conftest also has a [Helm plugin](https://github.com/instrumenta/helm-conftest) which makes testing Helm charts easier, and
35+
that plugin is also available as an Action.
36+
37+
You can use the action as follows:
38+
39+
```yaml
40+
on: push
41+
name: Validate
42+
jobs:
43+
conftest:
44+
runs-on: ubuntu-latest
45+
steps:
46+
- uses: actions/checkout@master
47+
- name: test
48+
uses: instrumenta/conftest-action/helm@master
49+
with:
50+
chart: mysql
51+
```
52+
53+
The Conftest Helm Action has a small number of properties which map to the parameters for Conftest itself. These are
54+
passed to the action using `with`, as demonstrated with `chart` in the above example.
55+
56+
| Property | Default | Description |
57+
| --- | --- | --- |
58+
| chart | - | *Required* which chart directory to test |
59+
| policy | policy | Where to find the policy folder or files |
60+
| namespace | main | The Rego namespace to use for testing |
61+
| output | stdout | How to format the output from Conftest (stdout, json or tap) |
62+
63+
64+

0 commit comments

Comments
 (0)
Please sign in to comment.