Skip to content

Commit 2fc92ae

Browse files
authored
docs(readme): examples (#14)
* cleanup readme * docs: readme example * Example in readme * docs: readme example
1 parent b12fb15 commit 2fc92ae

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ It's super easy to get started and use this GitHub Action to test your OPA Rego
3030
```yaml
3131
- name: Run OPA Rego Tests
3232
uses: masterpointio/github-action-opa-rego-test@main
33+
with:
34+
report_untested_files: true # Flag to check & report Rego files that does NOT have corresponding test files. Optional, defaults to false.
3335
```
3436
3537
<details>
@@ -143,6 +145,8 @@ Contributions are welcome! Please feel free to submit a Pull Request or open any
143145

144146
## 💬 Example Pull Request Comments
145147

148+
One of the testing steps is running the test workflow against this Action itself. You can see some live examples in the closed PR section, including this [example here](https://github.com/masterpointio/github-action-opa-rego-test/pull/9#issuecomment-2305253112).
149+
146150
- ![Masterpoint GitHub Actions OPA Rego Test PR Example](./assets/readme-example-1.png)
147151
- Using `report_untested_files` to indicate policies without corresponding tests.
148152
- ![Masterpoint GitHub Actions OPA Rego Test PR Example](./assets/readme-example-2.png)

0 commit comments

Comments
 (0)