Skip to content

docs(readme): examples #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 6, 2024
Merged

docs(readme): examples #14

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15934af
cleanup readme
oycyc Aug 22, 2024
b96728e
docs: readme example
oycyc Aug 22, 2024
622b625
Example in readme
oycyc Aug 23, 2024
613867c
docs: readme example
oycyc Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```

<details>
Expand Down Expand Up @@ -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
Loading