Skip to content
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.

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

docs(readme): examples #14

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs(readme): examples #14

wants to merge 3 commits into from

Conversation

oycyc
Copy link
Collaborator

@oycyc oycyc commented Aug 22, 2024

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.

Copy link
Contributor

github-actions bot commented Aug 22, 2024

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/ignore-changes-outside-root_test.rego ✅ PASS 12 12 92.86%
Uncovered Lines40
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/tests/track-using-labels_test.rego ✅ PASS 8 8 45.45%
Uncovered Lines3, 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/enforce-password-length_test.rego ✅ PASS 3 3 90.91%
Uncovered Lines29
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/notification-stack-failure-origins_test.rego ✅ PASS 7 7 96.67%
Uncovered Lines80
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/enforce-module-use-policy_test.rego ✅ PASS 4 4 47.83%
Uncovered Lines37, 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/readers-writers-admins-teams_test.rego ✅ PASS 6 6 83.33%
Uncovered Lines16, 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/cancel-in-progress-runs_test.rego ✅ PASS 2 2 83.33%
Uncovered Lines16
Show Details✅ data.spacelift.test_cancel_runs_allowed
✅ data.spacelift.test_cancel_runs_denied
./examples/tests/do-not-delete-stateful-resources_test.rego ✅ PASS 5 5 85.71%
Uncovered Lines34
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/drift-detection.rego ⚠️ NO TESTS 0 0 N/A
Show DetailsNo test file found

Report generated by 🧪 GitHub Actions for OPA Rego Test

Copy link
Contributor

github-actions bot commented Aug 22, 2024

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 622b625

@oycyc oycyc changed the title docs: readme example docs(readme): examples Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant