diff --git a/README.md b/README.md index 09bf394..8efbaa3 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,8 @@ It's super easy to get started and use this GitHub Action to test your OPA Rego ```yaml - name: Run OPA Rego Tests uses: masterpointio/github-action-opa-rego-test@main + with: + report_untested_files: true # Flag to check & report Rego files that does NOT have corresponding test files. Optional, defaults to false. ```
@@ -143,11 +145,9 @@ Contributions are welcome! Please feel free to submit a Pull Request or open any ## 💬 Example Pull Request Comments +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). + - ![Masterpoint GitHub Actions OPA Rego Test PR Example](./assets/readme-example-1.png) - Using `report_untested_files` to indicate policies without corresponding tests. - ![Masterpoint GitHub Actions OPA Rego Test PR Example](./assets/readme-example-2.png) - ![Masterpoint GitHub Actions OPA Rego Test PR Example](./assets/readme-example-3.png) - -### TODO - -- publish to marketplace