Quickstart: Running your first recipe
To help orient you to Moderne, let's walk through how to run a recipe on some open-source projects that we have imported into Moderne.
In this guide, we will:
If you're an enterprise user, you'll need to navigate to and sign in with the link your company has provided you. Please do that and skip to step 3.
If you're not an enterprise user, go to https://public.moderne.io and press "Sign-in with GitHub" as seen below:
The first time you sign in to Moderne through GitHub, you will be presented with an authorization prompt for a few permissions to help enhance your experience.
GitHub permission request
After you've logged in and granted the appropriate permissions, you'll arrive at the Moderne home page.
If you went to run a recipe right now, you would find that some repositories are already selected to run against. In public Moderne, the
Defaultorganization is selected (a diverse selection of open-source repositories). In an enterprise instance of Moderne, the
Allorganization is typically selected instead (meaning a recipe would run against every repository in your organization).
If you'd prefer to run against a different group of repositories so that you can get relevant results more quickly, you can: select the organization that matches your needs, set up the Organization service (for enterprise users), or follow these instructions on how to make a repository group.
Once you've decided what repositories you want to run recipes against, click on
Marketplaceon the left side of the screen:
Moderne home page
This will take you to a page that lists all of the recipe categories:
Moderne recipe marketplace
Let's find a good recipe to start from to help illustrate how to search across multiple repositories.
- 3.Click on the
Common static analysis issuesrecipe.
Click Dry Run to start the recipe. You might be asked for additional GitHub permissions after you click this button.
On the results page, you will see a summary of your recipe criteria and an indication of progress.
Each result shows the number of files searched and how many changes were detected.
To see the proposed changes, click on either the
Actionsor the name of the repository (e.g. openrewrite/rewrite).
The resulting diff allows you to preview the changes from the recipe before you decide what you want to do.
If you're unsure why something changed, you can click on the three dots (
...) at the top right of any file and select
Why did this change?
Once you've confirmed you want to make the changes, the next course of action is to commit everything.
In the results view, select the repositories you want to commit and then click Commit Selected.
This will open a prompt that allows you to select different actions such as committing directly, opening a pull request, etc.
From this prompt, you can customize either the Branch Name or the Commit Message to match the contributing guidelines of a particular repository.
You've now run and committed your first recipe. Way to go!!