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 pr_reviews.md #1450

Merged
merged 1 commit into from
Nov 3, 2023
Merged

Update pr_reviews.md #1450

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: 4 additions & 3 deletions docs/docs/how-to/pr_reviews.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,16 @@ import TabItem from '@theme/TabItem';
## Prerequisites

* The `minder` CLI application
* A Stacklok account
* A Minder account
* An enrolled Provider (e.g., GitHub) and registered repositories

## Create the PR vulnerability check rule
Start by creating a rule that checks if a pull request adds a new dependency with known vulnerabilities. If it does,
Minder will review the PR and suggest changes.

Note that Minder is only able to review a PR if it's running under a different
user than the one that created the PR. If the PR is created by the same user,
Minder only provide a comment with the vulnerability information. An alternative
Minder only provides a comment with the vulnerability information. An alternative
is to use the `commit-status` action instead of `review` where Minder will set
the commit status to `failure` if the PR introduces a new vulnerability which can
then be used to block the PR. This requires an additional step though, where
Expand Down Expand Up @@ -127,4 +128,4 @@ pull_request:
Create the profile in Minder:
```
minder profile create -f profile.yaml
```
```