Skip to content

Commit

Permalink
Added instructions for Helm Action
Browse files Browse the repository at this point in the history
  • Loading branch information
garethr committed Oct 30, 2019
1 parent 9f2d968 commit 2b17b6e
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,38 @@ passed to the action using `with`, as demonstrated with `files` in the above exa
| policy | policy | Where to find the policy folder or files |
| namespace | main | The Rego namespace to use for testing |
| output | stdout | How to format the output from Conftest (stdout, json or tap) |


## Helm

Conftest also has a [Helm plugin](https://github.com/instrumenta/helm-conftest) which makes testing Helm charts easier, and
that plugin is also available as an Action.

You can use the action as follows:

```yaml
on: push
name: Validate
jobs:
conftest:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: test
uses: instrumenta/conftest-action/helm@master
with:
chart: mysql
```

The Conftest Helm Action has a small number of properties which map to the parameters for Conftest itself. These are
passed to the action using `with`, as demonstrated with `chart` in the above example.

| Property | Default | Description |
| --- | --- | --- |
| chart | - | *Required* which chart directory to test |
| policy | policy | Where to find the policy folder or files |
| namespace | main | The Rego namespace to use for testing |
| output | stdout | How to format the output from Conftest (stdout, json or tap) |



0 comments on commit 2b17b6e

Please sign in to comment.