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.

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

docs(guided remediation): document override strategy for Maven remediation #1181

Merged
merged 17 commits into from
Jan 21, 2025

Conversation

michaelkedar
Copy link
Member

@michaelkedar michaelkedar commented Aug 14, 2024

Update guided remediation docs page for Maven override strategy.
I've tried to make sure it covers everything - let me know if something's missing.

Currently at rendered at https://michaelkedar.github.io/osv-scanner/experimental/guided-remediation/

@michaelkedar michaelkedar added the guided remediation Related to guided remediation / osv-scanner fix label Aug 14, 2024
@codecov-commenter
Copy link

codecov-commenter commented Aug 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.98%. Comparing base (361452a) to head (8c91a9e).
Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1181      +/-   ##
==========================================
+ Coverage   66.66%   68.98%   +2.32%     
==========================================
  Files         200      197       -3     
  Lines       19005    18800     -205     
==========================================
+ Hits        12669    12970     +301     
+ Misses       5655     5127     -528     
- Partials      681      703      +22     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.
Copy link

This pull request has not had any activity for 60 days and will be automatically closed in two weeks

@github-actions github-actions bot added the stale The issue or PR is stale and pending automated closure label Nov 10, 2024
@cuixq cuixq removed the stale The issue or PR is stale and pending automated closure label Nov 18, 2024
Copy link

This pull request has not had any activity for 60 days and will be automatically closed in two weeks

@github-actions github-actions bot added the stale The issue or PR is stale and pending automated closure label Jan 17, 2025
@cuixq cuixq removed the stale The issue or PR is stale and pending automated closure label Jan 17, 2025
@cuixq cuixq self-requested a review January 17, 2025 04:05
@cuixq
Copy link
Contributor

cuixq commented Jan 17, 2025

@michaelkedar shall we review this PR to make sure everything is up to date?

@michaelkedar michaelkedar marked this pull request as ready for review January 20, 2025 22:53
Copy link
Contributor

@cuixq cuixq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - just some minor comments

docs/guided-remediation.md Outdated Show resolved Hide resolved
docs/guided-remediation.md Outdated Show resolved Hide resolved
### Maven

- Dependencies that use properties in their `groupId`/`artifactId` may not be updated correctly.
- Support for profiles is limited.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe link to an issue is there is one?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't seem to have specific issues for these.
I'm also not 100% on the extent to which we support/don't support these.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use these two? #1238 and #1239

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why I didn't see these. Added the links.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

Copy link
Collaborator

@oliverchang oliverchang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice! some nits

docs/guided-remediation.md Outdated Show resolved Hide resolved
docs/guided-remediation.md Outdated Show resolved Hide resolved
docs/guided-remediation.md Show resolved Hide resolved
docs/guided-remediation.md Show resolved Hide resolved
### Maven

- Dependencies that use properties in their `groupId`/`artifactId` may not be updated correctly.
- Support for profiles is limited.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use these two? #1238 and #1239

docs/guided-remediation.md Outdated Show resolved Hide resolved
@michaelkedar michaelkedar merged commit 33c8a7a into google:main Jan 21, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
guided remediation Related to guided remediation / osv-scanner fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants