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

Add test examples to docs again #74

Open
mike-solomon opened this issue Aug 21, 2023 · 6 comments
Open

Add test examples to docs again #74

mike-solomon opened this issue Aug 21, 2023 · 6 comments
Labels
enhancement New feature or request

Comments

@mike-solomon
Copy link
Contributor

See this issue for more information.

@mike-solomon mike-solomon added the enhancement New feature or request label Aug 21, 2023
@timtebeek
Copy link
Contributor

We can optionally transfer that issue here if you think that makes sense. :)

@timtebeek timtebeek moved this to Backlog in OpenRewrite Aug 21, 2023
@timtebeek
Copy link
Contributor

Discussed internally: We've decided to pull extract and generation of examples to this project, no longer distribute the examples with every recipe jar. That should fully decouple (also in time) the extraction from any build logic.

@timtebeek
Copy link
Contributor

As another alternative, which should be low-effort, we can also try to link directly to the tests from the docs & SaaS, where available. That saves on extraction logic.

@knutwannheden
Copy link
Contributor

If we could get the example extraction recipe into a hood shape, I think we could maybe also enable it again, but only have it run on release builds, so that it doesn't slow us down while developing.

@knutwannheden
Copy link
Contributor

Reading through the thread again, it seems like we probably haven't addressed all issues yet, which would require us having that recipe running again.

@timtebeek
Copy link
Contributor

Had another quick look at this; and would like to propose an alternative:

  1. Remove RecipeExamplesTask and ExamplesExtractor recipe from rewrite-build-gradle-plugin
  2. Move ExamplesExtractor recipe into a recipe module, or rewrite-test
  3. Call the Moderne CLI to run ExamplesExtractor against all OpenRewrite recipe module LSTs here
  4. Load recipe examples through YamlResourceLoader here, and mix into recipe descriptors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

3 participants