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.

Sign up for GitHub

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 Quick Start to README for mvn Runs #45

Merged
merged 1 commit into from
Aug 27, 2023
+13 −0
Merged

Add Quick Start to README for mvn Runs #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
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:
sghill marked this conversation as resolved.
Show resolved Hide resolved

```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