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

Document TypeTable #350

Open
timtebeek opened this issue Feb 13, 2025 · 0 comments
Open

Document TypeTable #350

timtebeek opened this issue Feb 13, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@timtebeek
Copy link
Contributor

What problem are you trying to solve?

Document the new ./gradlew createTypeTable task as a suggested replacement for ./gradlew downloadRecipeDependencies.

Describe the solution you'd like

Right now we document the old task here:

After the plugin has been applied, you can run the `downloadRecipeDependencies` task. This will download the corresponding jar for every dependency specified in `recipeDependencies` and put them in the `src/main/resources/META-INF/rewrite` directory. From there, you could use the `classpathFromResources` function in the same way as above.

Ideally we call out the new task first, before indicating that there's an older way to so things as well.

TypeTables are a potential replacement in most cases, with only some known limitations where it concerns meta annotations right now.

There's also a FAQ entry that could use an update to call out TypeTable as we potential solution:
https://docs.openrewrite.org/reference/faq#why-do-artifact-scanners-detect-vulnerabilities-in-recipe-artifactsjars

Have you considered any alternatives or workarounds?

Seems too early to fully remove packaged recipe jars.

Additional context

@timtebeek timtebeek added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 13, 2025
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: No status
Development

No branches or pull requests

1 participant