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.

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

Update rule configuration #179

Merged
merged 4 commits into from
Oct 11, 2024
Merged

Update rule configuration #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4dc5a61
Remove branch name requirement in rules
ethomson Oct 10, 2024
6f9e94d
Remove filename requirement in rules
ethomson Oct 10, 2024
b1509e3
Remove schedule_interval from dependabot rule
ethomson Oct 10, 2024
e9f83b6
Remove filename requirement in security rules
ethomson Oct 10, 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
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_allow_deletions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
type: object
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_allow_force_pushes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
type: object
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_allow_fork_syncing.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
properties:
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_enabled.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
rule_schema: {}
# Defines the configuration for ingesting data relevant for the rule
ingest:
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_enforce_admins.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
properties:
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_lock_branch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
properties:
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_require_conversation_resolution.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
properties:
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_require_linear_history.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
properties:
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_require_pull_request_approving_review_count.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
properties:
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_require_pull_request_code_owners_review.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
properties:
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_require_pull_request_dismiss_stale_reviews.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
properties:
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_require_pull_request_last_push_approval.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
properties:
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_require_pull_requests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
properties:
Expand Down
4 changes: 1 addition & 3 deletions rule-types/github/branch_protection_require_signatures.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ def:
properties:
branch:
type: string
description: "The name of the branch to check. If left empty, the default branch will be used."
required:
- branch
description: "The name of the branch to check. If not specified, the repository's default branch will be used."
# Defines the schema for writing a rule with this rule being checked
rule_schema:
type: object
Expand Down
6 changes: 0 additions & 6 deletions rule-types/github/dependabot_configured.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,13 @@ def:
description: |
The package ecosystem that the rule applies to.
For example pip, gomod, npm, docker, github-actions, etc.
schedule_interval:
type: string
description: |
This option is no longer used. It's, however marked as required, so we can't remove
it for backwards compatibility.
apply_if_file:
type: string
description: |
Optional. If specified, the rule will only be evaluated if the given file exists.
This is useful for rules that are only applicable to certain types of repositories.
required:
- package_ecosystem
- schedule_interval
# Defines the configuration for ingesting data relevant for the rule
ingest:
type: git
Expand Down
2 changes: 0 additions & 2 deletions rule-types/github/security_insights.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ def:
description: |
The path to the Security Insights file
default: SECURITY-INSIGHTS.yml
required:
- filename
# Defines the configuration for ingesting data relevant for the rule
ingest:
type: git
Expand Down
2 changes: 0 additions & 2 deletions rule-types/github/security_insights_dep_policy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,6 @@ def:
description: |
The path to the Security Insights file
default: SECURITY-INSIGHTS.yml
required:
- filename
# Defines the configuration for ingesting data relevant for the rule
ingest:
type: git
Expand Down
2 changes: 0 additions & 2 deletions rule-types/github/security_policy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ def:
description: |
Path to the security policy file
default: SECURITY.md
required:
- filename
# Defines the configuration for ingesting data relevant for the rule
ingest:
type: git
Expand Down
Loading