Skip to content

Commit

Permalink
Update how-to for PR remediation
Browse files Browse the repository at this point in the history
Signed-off-by: Radoslav Dimitrov <[email protected]>
  • Loading branch information
rdimitrov committed Nov 5, 2023
1 parent 4a4728e commit 7e14a3d
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/docs/how-to/remediate-pullrequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ the reference rule types provided by the Minder team.

Fetch all the reference rules by cloning the [minder-rules-and-profiles repository](https://github.com/stacklok/minder-rules-and-profiles).

```
```bash
git clone https://github.com/stacklok/minder-rules-and-profiles.git
```

In that directory you can find all the reference rules and profiles.
```
```bash
cd minder-rules-and-profiles
```

Create the `dependabot_configured` rule type in Minder:
```
```bash
minder rule_type create -f rule-types/github/dependabot_configured.yaml
```

Expand Down Expand Up @@ -85,7 +85,7 @@ repository:
</Tabs>
Create the profile in Minder:
```
```bash
minder profile create -f profile.yaml
```

Expand All @@ -95,3 +95,9 @@ i.e., Go, NPM, etc.
If a repository does not have Dependabot enabled, Minder will create a pull request with the necessary configuration
to enable it. Alongside the PR, Minder will also create a Security Advisory alert that will be present until the issue
is resolved.

## Limitations

* The pull request auto remediation feature is only available for rule types that support it.
* There's no support for creating pull requests that modify the content of existing files yet.
* The created pull request should be closed manually if the issue is resolved through other means. The profile status and any related alerts will be updated/closed automatically though.

0 comments on commit 7e14a3d

Please sign in to comment.