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

Add a display name for each rule type #146

Merged
merged 1 commit into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions rule-types/github/actions_check_default_permissions.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
version: v1
type: rule-type
name: actions_check_default_permissions
display_name: Ensure GitHub Actions workflows set their permissions
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/actions_check_pinned_tags.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: actions_check_pinned_tags
display_name: Ensure immutable version of GitHub action
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/allowed_selected_actions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: allowed_selected_actions
display_name: Limit the permitted GitHub actions by creator
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/artifact_attestation_slsa.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: artifact_attestation_slsa
display_name: Verify the integrity of an artifact
context:
provider: github
description: |
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/artifact_signature.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: artifact_signature
display_name: Ensure artifacts are signed and verified
severity:
value: high
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/automatic_branch_deletion.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: automatic_branch_deletion
display_name: Automatically delete branch after merge
severity:
value: info
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/branch_protection_allow_deletions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_allow_deletions
display_name: Prevent permanent branch deletion
severity:
value: medium
context:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_allow_force_pushes
display_name: Prevent overwriting git history
severity:
value: medium
context:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_allow_fork_syncing
display_name: Allow forks to pull changes from locked branches
severity:
value: low
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/branch_protection_enabled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_enabled
display_name: Ensure a branch protection rule is set up
severity:
value: high
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/branch_protection_enforce_admins.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_enforce_admins
display_name: Enforce branch protection rules for admins
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/branch_protection_lock_branch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_lock_branch
display_name: Set a branch as read-only
severity:
value: medium
context:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_require_conversation_resolution
display_name: Prevent merging PRs with unresolved conversations
severity:
value: info
context:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_require_linear_history
display_name: Forbid merge commits
severity:
value: info
context:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_require_pull_request_approving_review_count
display_name: Require a number of reviews before merging a PR
severity:
value: medium
context:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_require_pull_request_code_owners_review
display_name: Require a code owner review before merging a PR
severity:
value: low
context:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_require_pull_request_dismiss_stale_reviews
display_name: Forbid merging PRs with un-approved commits
severity:
value: info
context:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_require_pull_request_last_push_approval
display_name: Disregard self-approvals on PRs
severity:
value: low
context:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_require_pull_requests
display_name: Only merge code from pull requests
severity:
value: medium
context:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: branch_protection_require_signatures
display_name: Require commits to be signed
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/codeql_enabled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: codeql_enabled
display_name: Enable CodeQL for vulnerability scanning
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/default_workflow_permissions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: default_workflow_permissions
display_name: Customize the default GitHub workflow permissions
severity:
value: high
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/dependabot_configured.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: dependabot_configured
display_name: Enable Dependabot for automated dependency updates
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/dockerfile_no_latest_tag.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: dockerfile_no_latest_tag
display_name: Prevent Dockerfile from using volatile 'latest' tag
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/github_actions_allowed.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: github_actions_allowed
display_name: Limit the permitted GitHub actions by type
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/invisible_characters_check.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
version: v1
type: rule-type
name: invisible_characters_check
display_name: Check for invisible characters in pull requests
severity:
value: high
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/license.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: license
display_name: Ensure a license file is present
severity:
value: low
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/mixed_scripts_check.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
version: v1
type: rule-type
name: mixed_scripts_check
display_name: Check for mixed scripts in pull requests
severity:
value: high
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/no_binaries_in_repo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: no_binaries_in_repo
display_name: Ensure no binary artifacts are committed
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/no_open_security_advisories.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: no_open_security_advisories
display_name: Verify there are no open security advisories
severity:
value: low
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/pr_trusty_check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: pr_trusty_check
display_name: Ensure pull requests do not add dependencies with a low Trusty
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/pr_vulnerability_check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: pr_vulnerability_check
display_name: Ensure pull requests do not add vulnerable dependencies
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/repo_action_allow_list.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: repo_action_allow_list
display_name: Ensure that only allowed GitHub actions run in a repository
severity:
value: info
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/repo_workflow_access_level.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: repo_workflow_access_level
display_name: Limit the external access of private repositories
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/scorecard_enabled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: scorecard_enabled
display_name: Enable the Scorecard GitHub Action
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/secret_push_protection.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: secret_push_protection
display_name: Enable secret push protection to avoid pushing hardcoded secrets
severity:
value: high
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/secret_scanning.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: secret_scanning
display_name: Enable secret scanning to detect hardcoded secrets
severity:
value: high
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/security_insights.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: security_insights
display_name: Verify the presence of a Security Insights file
severity:
value: low
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/security_insights_dep_policy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: security_insights_dep_policy
display_name: Verify a dependency policy exists in the Security Insights file
severity:
value: low
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/security_policy.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
version: v1
type: rule-type
name: security_policy
display_name: Ensure a security policy file exists
severity:
value: medium
context:
Expand Down
1 change: 1 addition & 0 deletions rule-types/github/trivy_action_enabled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
version: v1
type: rule-type
name: trivy_action_enabled
display_name: Ensure Trivy is enabled for vulnerability scanning
severity:
value: medium
context:
Expand Down
Loading