Skip to content

Commit

Permalink
docs formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelkedar committed Aug 20, 2024
1 parent 88375fd commit dc48e83
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/guided-remediation.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,16 +227,18 @@ A vulnerability is only considered if it satisfies all the conditions set by the
The following flag may be used to limit the patches allowed for your dependencies:

- `--upgrade-config=<[package-name:]level>` Sets the maximum upgrade level allowed for a package. Can be repeated for multiple packages.

`level` is the SemVer component to allow updates to, can be one of `major`, `minor`, `patch`, or `none`. e.g. If a package was at version `1.2.3`

`level` is the SemVer component to allow updates to, can be one of `major`, `minor`, `patch`, or `none`. e.g. If a package was at version `1.2.3`

- `major` allows for updates to any version `>=1.2.3`
- `minor` allows for updates `>=1.2.3, <2.0.0`
- `patch` allows for updates `>=1.2.3, <1.3.0`
- `none` disallows any updates

If `package-name:` is omitted, `level` is applied to all packages. Default is `--upgrade-config=major`.

Example usage:

- `--upgrade-config=minor` - disallow any patches that would bump a major version of any package.
- `--upgrade-config=foo:minor` - disallow any patches that bumps package `foo` by a major version. Other packages may receive major version-updating patches.
- `--upgrade-config=none --upgrade-config=foo:patch` - only allow patches to package `foo`, and only allow changes to `foo`'s SemVer patch level.
Expand Down

0 comments on commit dc48e83

Please sign in to comment.