rewrite-docs icon indicating copy to clipboard operation
rewrite-docs copied to clipboard

Document publishing to Maven local for Maven

Open timtebeek opened this issue 1 year ago • 0 comments

What problem are you trying to solve?

We have publishing to Maven local documented for Gradle: https://docs.openrewrite.org/authoring-recipes/recipe-development-environment#local-publishing-for-testing

Recently we added a pom.xml to https://github.com/moderneinc/rewrite-recipe-starter But folks don't yet see how to use recipe jars built with Maven.

Describe the solution you'd like

It would help to document how to publish to Maven local through Maven as well, both on the above guide and in the starter README.

The step should be easy

  1. Run Maven install to create a jar and publish that to Maven local
mvn install
  1. Use the GAV coordinates that Maven just used when configuring the Maven or Gradle plugins
  2. Optionally add a small snippet how to install recipes to the CLI using those same coordinates.

Additional context

As requested by a customer. /cc @mike-solomon

timtebeek avatar Apr 30 '24 18:04 timtebeek