docs(guided remediation): document override strategy for Maven remediation #1181
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaelkedar
added
the
guided remediation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1181 +/- ##
==========================================
+ Coverage 67.81% 67.82% +0.01%
==========================================
Files 174 174
Lines 16769 16769
==========================================
+ Hits 11372 11374 +2
+ Misses 4767 4766 -1
+ Partials 630 629 -1 ☔ View full report in Codecov by Sentry. |
oliverchang
reviewed
Aug 14, 2024
| {: .note } | ||
| The `override` strategy is currently only supported in `--non-interactive` mode. | ||
|
|
||
| Maven allows for the version specification of direct and indirect dependencies to be overwritten by a POM's `<dependencyManagement>`. This mechanism can be used to force a vulnerable dependency to be updated to a newer, non-vulnerable version. Overriding dependency versions can enable otherwise inaccessible updates, but it also risks breaking the application if the new version is incompatible with other dependencies. |
There was a problem hiding this comment.
We update the normal <dependencies> section if it already exists there right?
There was a problem hiding this comment.
Yeah, I'll adjust the wording
oliverchang
reviewed
Aug 14, 2024
docs/guided-remediation.md
Outdated
|
|
||
| | File Format | Supported [Remediation Strategies](#remediation-strategies) | | ||
| | :---------------------------------------------- | :---------------------------------------------------------- | | ||
| | `package-lock.json` lockfile | [`in-place`](#in-place-lockfile-remediation) | |
There was a problem hiding this comment.
probably also worth spelling out the package ecosystem in (new) first column?
michaelkedar
commented
Aug 29, 2024
| ``` | ||
|
|
||
| <details markdown="1"> | ||
| <summary><b>Sample override output</b></summary> |
There was a problem hiding this comment.
TODO: regenerate output with #1210
cuixq
added a commit
that referenced
this pull request
Oct 24, 2024
#1286 adds support for Maven registry during resolution. As a follow up, this PR updates the documentation for transitive scanning about specifying data source during resolution as well as specifying Maven registry. This PR also corrects the deps.dev API version we are using. We also need to update the documentation in #1181.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WIP
Currently at rendered at https://michaelkedar.github.io/osv-scanner/experimental/guided-remediation/