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 Trusty PR evaluator/ruletype documentation #3423

Merged
merged 1 commit into from
May 27, 2024
Merged

Update Trusty PR evaluator/ruletype documentation #3423

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
7 changes: 6 additions & 1 deletion docs/docs/ref/rules/pr_trusty_check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ The `pr_trusty_check` rule has the following options:
- `action` (string): The action to take if a package with a low score is found. Valid values are:
- `summary`: The evaluator engine will add a single summary comment with a table listing the packages with low scores found
- `profile_only`: The evaluator engine will merely pass on an error, marking the profile as failed if a packages with low scores is found
- `review`: The trusty evaluator will add a review asking for changes when problematic dependencies are found. Use the review action to block any pull requests introducing dependencies that break the policy established defined by the rule.
- `ecosystem_config`: An array of ecosystem configurations to check. Each ecosystem configuration has the following options:
- `name` (string): The name of the ecosystem to check. Currently `npm` and `pypi` are supported.
- `pi_threshold` (number): The minimum Trusty score for a dependency to be considered safe.
- `score` (number): The minimum Trusty score for a dependency to be considered safe.
- `provenance` (number): Minimum provenance score to consider a package's proof of origin satisfactory.
- `activity` (number): Minimum activity score to consider a package as active.
- `allow_malicious` (boolean): Don't raise an error when a PR introduces dependencies known to be malicious (not recommended)
- `allow_deprecated` (boolean): Don't block when a pull request introduces dependencies marked as deprectaed upstream.