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

Minor ruletype descriptions #90

Merged
merged 1 commit into from
Apr 12, 2024
Merged

Minor ruletype descriptions #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion rule-types/github/actions_check_pinned_tags.yaml
View file
Open in desktop
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
View file
Open in desktop
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 * * * *'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I /think/ this should be safe because we don't actually enforce the defaults on the back end level, so the defaults would be kind of advisory use for FE.

required:
- languages
- schedule_interval
Expand Down
2 changes: 1 addition & 1 deletion rule-types/github/dependabot_configured.yaml
View file
Open in desktop
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
View file
Open in desktop
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
Loading