Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/instrumenta/conftest-action
A GitHub Action for using Conftest
https://github.com/instrumenta/conftest-action
actions conftest instrumenta openpolicyagent
Last synced: about 2 months ago
JSON representation
A GitHub Action for using Conftest
- Host: GitHub
- URL: https://github.com/instrumenta/conftest-action
- Owner: instrumenta
- License: other
- Created: 2019-08-17T06:47:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-29T09:07:09.000Z (about 3 years ago)
- Last Synced: 2024-10-28T17:37:51.346Z (about 2 months ago)
- Topics: actions, conftest, instrumenta, openpolicyagent
- Size: 18.6 KB
- Stars: 33
- Watchers: 3
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Conftest
A [GitHub Action](https://github.com/features/actions) for using [Conftest](https://github.com/instrumenta/conftest) in your workflows.
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@master
with:
files: deployment.yaml
```
The Conftest 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 `files` in the above example.
| Property | Default | Description |
| --- | --- | --- |
| files | - | *Required* which files 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) |
## 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) |