From d2ee7c9d19394d93bbd5712a3f6a168ee81cde50 Mon Sep 17 00:00:00 2001 From: Steve Hill Date: Sat, 26 Aug 2023 15:06:09 -0700 Subject: [PATCH] docs(README): add quickstart for mvn cli runs Refs: #44 --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 5b91242..f7be3ab 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,19 @@ Additionally, depending on newer versions of Jenkins allows our builds to pick u These deprecations can often be migrated with new OpenRewrite recipes. Proactively handling deprecations in the plugins we depend on allows us to avoid runtime issues if and when the deprecated code is removed. +## Quick start + +[Running Rewrite on a Maven project without modifying the build][mvn-cli] is very helpful for getting started. +To run the `org.openrewrite.jenkins.github.AddTeamToCodeowners` recipe: + +```shell +$ mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \ + -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-jenkins:RELEASE \ + -Drewrite.activeRecipes=org.openrewrite.jenkins.migrate.hudson.UtilGetPastTimeStringToGetTimeSpanString +``` + +[mvn-cli]: https://docs.openrewrite.org/running-recipes/running-rewrite-on-a-maven-project-without-modifying-the-build + ## How to use? See the full documentation at [docs.openrewrite.org](https://docs.openrewrite.org/).