Add guide for running Rewrite on Infrastructure-as-Code projects#507
Open
timtebeek wants to merge 5 commits into
Open
Add guide for running Rewrite on Infrastructure-as-Code projects#507timtebeek wants to merge 5 commits into
timtebeek wants to merge 5 commits into
Conversation
Documents three approaches (Moderne CLI, host Gradle project, standalone runner) for applying OpenRewrite recipes to repositories without a Maven or Gradle build, and links the same pattern over to YAML, Docker, GitHub Actions/GitLab CI, and Protobuf sources.
Reframe Option 2 around Moderne CLI availability rather than OSS preference, and add a stability warning to the Option 3 standalone runner since the embedded parser/recipe APIs may change across releases.
Rename the page to "Running Rewrite on an Infrastructure-as-Code project" and lead with the general "no Maven/Gradle build" problem. Terraform remains the running example throughout; the source-type table moves the YAML, Docker, CI workflow, and Protobuf alternatives from a tip aside into the page's structure so they are discoverable up front.
The reviewer asked the authoring section to do more to illustrate that other IaC languages follow the same approach. Add a table listing the LST and test directories for each language module, and fix two broken references found while verifying paths: the live Dockerfile module lives under openrewrite/rewrite (the standalone rewrite-docker repo is archived), and the protobuf package is `protobuf`, not `proto`.
timtebeek
changed the title
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
docs/running-recipes/running-rewrite-on-an-infrastructure-as-code-project.mdcovering three ways to apply OpenRewrite recipes to IaC repos that have no Maven or Gradle build: the Moderne CLI, a host Gradle project (with a step-by-step walkthrough in a collapsible block), and a standalone Java runner.pom.xml/build.gradle" problem, with Terraform as the running example and a source-type table at the top covering YAML/Kubernetes/Helm, Dockerfiles, GitHub Actions / GitLab CI workflows, and Protobuf.sidebars.ts.Test plan
<details>blocks under Options 2 and 3 work.