Skip to content

Commit

Permalink
Minor ruletype descriptions
Browse files Browse the repository at this point in the history
A bunch of ruletype text updates I found while I was testing different
ruletypes through UI

- more ecosystem examples for the popular dependabot ecosystems
- provide a reasonable default for codeQL schedule
- say that minder will use builtin defaults for the OSV ruletype to make
  it clear that the user doesn't have to fill them in
- fix description of exclude for the action pinning ruletype
  • Loading branch information
jhrozek committed Apr 12, 2024
1 parent 9205484 commit 87a2684
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion rule-types/github/actions_check_pinned_tags.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def:
type: string
description: |
Exclude actions from being checked and remediated. Useful for actions that don't support SHA pinning such
as slsa-github-generator. Use the full owner/action@tag string here, e.g. actions/checkout@v3
as slsa-github-generator. Use the full owner/action format here, e.g. actions/checkout
# Defines the configuration for ingesting data relevant for the rule
ingest:
type: git
Expand Down
3 changes: 2 additions & 1 deletion rule-types/github/codeql_enabled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ def:
schedule_interval:
type: string
description: |
Only applicable for remediation. Sets the schedule interval for the workflow.
Sets the schedule interval in cron format for the workflow. Only applicable for remediation.
default: '30 * * * *'
required:
- languages
- schedule_interval
Expand Down
2 changes: 1 addition & 1 deletion rule-types/github/dependabot_configured.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def:
type: string
description: |
The package ecosystem that the rule applies to.
For example, npm, docker, github-actions, etc.
For example pip, gomod, npm, docker, github-actions, etc.
schedule_interval:
type: string
description: |
Expand Down
2 changes: 1 addition & 1 deletion rule-types/github/pr_vulnerability_check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def:
default: review
ecosystem_config:
type: array
description: "The configuration for the ecosystems to check."
description: "The configuration for the ecosystems to check. Optional. If not explicitly set, Minder's default configuration will be used."
items:
type: object
properties:
Expand Down

0 comments on commit 87a2684

Please sign in to comment.