Skip to main content

Writing and installing recipes

As a user of the Moderne Platform, you're probably run quite a few recipes. However, what if you none of the recipes in the catalog do what you want to do? In that case, you will need to write your own.

In this short guide, we will walk through how to get started with writing recipes, and the steps you need to take after to make them appear in your Moderne Platform instance.

Step 1: Write a recipe​

tip

Before writing a new recipe, it's a good idea to double-check that the recipe catalog doesn't have any recipes that do what you want or can be easily modified to meet your needs.

If your new recipe idea can be composed of many other recipes or if it can be created by taking an existing recipe and removing pieces of it, check out our doc on creating custom recipes with the recipe builder.

If your recipe is more complex than that, please check out the OpenRewrite recipe authoring documentation. Make sure to read over the documentation on the different types of recipes so that you can create a recipe that best meets your needs.

You may also find it beneficial to work through our recipe authoring workshop that will take you through the process of writing and running many different types of recipes.

Step 2: Create a recipe JAR​

After you're done writing your recipe(s), you will need to publish them to an artifact repository that is connected to your Moderne instance. An administrator from your organization should have configured this when they set up the Moderne agent. For instructions on how to configure this connection, please see the configuring an agent with Maven repository access doc or the configuring an agent with Artifactory access doc.

Once the connection has been set up, you will need to ensure your repository publishes the recipe artifacts to the artifact repository mentioned above.

The rewrite-recipe-starter project can serve as an example of how to publish an artifact. This repository is configured to publish to Moderne's open artifact repository (via the publishing task at the bottom of the build.gradle.kts file).

You may also find it useful to read over these other artifact publishing docs:

Step 3: Deploying your recipe to the Moderne Platform​

Uploading the recipe artifacts to the Moderne connected artifact repository is not enough for them to appear in the Moderne Platform. In order for them to become available in the platform, you will need to have an administrator from your organization follow the instructions for importing external recipes. Once that's done, you should see the recipe in the recipe catalog – and you should be able to run in inside of the Moderne Platform or the Moderne CLI.