Skip to content

Commit

Permalink
docs(README): add quickstart for mvn cli runs
Browse files Browse the repository at this point in the history
Refs: #44
  • Loading branch information
sghill committed Aug 26, 2023
1 parent 9ef4e18 commit d2ee7c9
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down

0 comments on commit d2ee7c9

Please sign in to comment.