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

Write a popular recipe guide for resolving vulnerable dependencies #288

Open
timtebeek opened this issue Jun 19, 2024 · 2 comments
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@timtebeek
Copy link
Contributor

What problem are you trying to solve?

Folks might not be aware that we are able to confidently solve vulnerabilities using OpenRewrite recipes, and also bump transitive dependencies.

Describe the solution you'd like

Guide folks towards the Find and fix vulnerable dependencies recipe, and educate them on

  1. how to set overrideTransitive: true to get Maven dependencyManagement or Gradle constraints added
    a. and explain how 80% of vulnerabilities are in transitive dependencies, otherwise missed by other tools
  2. explain how the recipe will only confidently bump patch versions, to the vulnerability recommended version
  3. explain the data table produced when passing in -Drewrite.exportDatatables=true, and the minor/major/no fix insights that gives
  4. guide them towards next steps such as
    a. directly using UpgradeDependencyVersion and UpgradeTransitiveDependencyVersion for minor version bumps,
    b. or the framework migration recipes for Spring, Micronaut and Quarkus for major version bumps.

Additional context

Came up in our OSS Slack.

@timtebeek timtebeek added the enhancement New feature or request label Jun 19, 2024
@timtebeek timtebeek added the documentation Improvements or additions to documentation label Jun 19, 2024
@timtebeek
Copy link
Contributor Author

cc @mike-solomon (but enjoy your holiday first!)

@mike-solomon
Copy link
Contributor

This has proven to be slightly problematic to document due to the fact that I can't get Gradle projects to generate data tables. Not entirely sure what I'm doing wrong as it seems like others may not have that issue 🤷

I'll come back to this in the future and see if I can figure it out. Jumping over to other doc issues for now, though.

@timtebeek timtebeek moved this to Backlog in OpenRewrite Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

2 participants