docs(readme): examples

[oycyc]

Describe your changes

Additional readme

Reminder:

• When the PR is ready, be sure to run npm run build to compile into the distribution /dist folder, which is the source code that the Action uses.

[github-actions]

Below is the Action testing on itself with this PR's source code against the /examples directory. Confirm it is as expected.

File	Status	Passed	Total	Coverage	Details
./examples/tests/enforce-module-use-policy_test.rego	✅ PASS	4	4	47.83% Uncovered Lines 37, 42, 46, 52, 54, 57, 60-61, 64, 68, 78, 80	Show Details ✅ data.spacelift.test_deny_creation_of_controlled_resource_type ✅ data.spacelift.test_deny_update_of_controlled_resource_type ✅ data.spacelift.test_allow_deletion_of_controlled_resource_type ✅ data.spacelift.test_allow_creation_of_uncontrolled_resource_type
./examples/tests/do-not-delete-stateful-resources_test.rego	✅ PASS	5	5	85.71% Uncovered Lines 34	Show Details ✅ data.spacelift.test_deny_s3_bucket_deletion ✅ data.spacelift.test_deny_db_instance_deletion ✅ data.spacelift.test_deny_efs_file_system_deletion ✅ data.spacelift.test_deny_dynamodb_table_deletion ✅ data.spacelift.test_allow_instance_deletion
./examples/tests/track-using-labels_test.rego	✅ PASS	8	8	45.45% Uncovered Lines 3, 5, 12-13, 23-26, 35, 37-38, 41	Show Details ✅ data.spacelift.test_track_different_branches ✅ data.spacelift.test_propose_non_empty_branch ✅ data.spacelift.test_propose_empty_branch ✅ data.spacelift.test_affected_directory ✅ data.spacelift.test_affected_extension ✅ data.spacelift.test_not_affected_directory ✅ data.spacelift.test_not_affected_extension ✅ data.spacelift.test_ignore_not_affected
./examples/tests/readers-writers-admins-teams_test.rego	✅ PASS	6	6	83.33% Uncovered Lines 16, 24, 28	Show Details ✅ data.spacelift_test.test_allow_writers ✅ data.spacelift_test.test_allow_admins ✅ data.spacelift_test.test_allow_readers ✅ data.spacelift_test.test_space_admin_access ✅ data.spacelift_test.test_space_write_access ✅ data.spacelift_test.test_space_read_access
./examples/tests/enforce-password-length_test.rego	✅ PASS	3	3	90.91% Uncovered Lines 29	Show Details ✅ data.spacelift.test_deny_creation_of_password_with_less_than_16_characters ✅ data.spacelift.test_warn_creation_of_password_between_16_and_20_characters ✅ data.spacelift.test_allow_creation_of_password_longer_than_20_characters
./examples/tests/cancel-in-progress-runs_test.rego	✅ PASS	2	2	83.33% Uncovered Lines 16	Show Details ✅ data.spacelift.test_cancel_runs_allowed ✅ data.spacelift.test_cancel_runs_denied
./examples/tests/notification-stack-failure-origins_test.rego	✅ PASS	7	7	96.67% Uncovered Lines 80	Show Details ✅ data.spacelift.test_slack_notification_for_tracked_failed_run ✅ data.spacelift.test_no_slack_notification_for_non_tracked_run ✅ data.spacelift.test_no_slack_notification_for_successful_run ✅ data.spacelift.test_slack_notification_with_unknown_github_user ✅ data.spacelift.test_pr_comment_for_tracked_failed_run ✅ data.spacelift.test_no_pr_comment_for_non_tracked_run ✅ data.spacelift.test_no_pr_comment_for_successful_run
./examples/tests/ignore-changes-outside-root_test.rego	✅ PASS	12	12	92.86% Uncovered Lines 40	Show Details ✅ data.spacelift.test_affected_no_files ✅ data.spacelift.test_affected_tf_files ✅ data.spacelift.test_affected_no_tf_files ✅ data.spacelift.test_affected_outside_project_root ✅ data.spacelift.test_ignore_affected ✅ data.spacelift.test_ignore_not_affected ✅ data.spacelift.test_ignore_tag ✅ data.spacelift.test_propose_affected ✅ data.spacelift.test_propose_not_affected ✅ data.spacelift.test_track_affected ✅ data.spacelift.test_track_not_affected ✅ data.spacelift.test_track_not_stack_branch
./examples/drift-detection.rego	⚠️ NO TESTS	0	0	N/A	Show Details No test file found

Report generated by 🧪 GitHub Actions for OPA Rego Test

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟢	Statements	90.07%	136/151
🟢	Branches	84.51%	60/71
🟢	Functions	81.82%	9/11
🟢	Lines	90.41%	132/146

Test suite run success

19 tests passing in 1 suite.

Report generated by 🧪jest coverage report action from 613867c

[coderabbitai]

Warning

Rate limit exceeded

@oycyc has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 4170c48 and 613867c.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.