jlengrand/moderne-docs
1
0
Fork 0
mirror of https://github.com/jlengrand/moderne-docs.git synced 2026-03-10 08:31:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: frame out recipe builder

Browse Source
This commit is contained in:
Scott Jungling
2021-08-26 14:08:09 -07:00
parent a70dfa295f
commit 8541bd4d2f
1 changed files with 41 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
how-to/creating-your-own-recipes-with-builder.md
View File

@@ -1,6 +1,8 @@
# Creating your own recipes with Builder
# Create custom recipes with Builder
Moderne provides the ability to create custom recipes from our existing recipe catalog through _Recipe_ _Builder._ The Recipe Builder allows you to:
Moderne provides the ability to create custom recipes from our existing recipe catalog through _Recipe_ _Builder._
The Recipe Builder allows you to:
1. Import declarative recipes authored in YAML.
2. Export declarative recipes as YAML and include them in your project.
@@ -8,14 +10,45 @@ Moderne provides the ability to create custom recipes from our existing recipe c
Let's build a custom recipe!
Step 1: Import an example recipe
## Step 1: Import an example recipe
![](../.gitbook/assets/builder-meta-data.png)
Let's start with a simple recipe to import.
![](../.gitbook/assets/builder-import-yaml.png)
{% code title="sample-recipe.yml" %}
![](../.gitbook/assets/builder-recipe-list.png)
```yml
type: specs.openrewrite.org/v1beta/recipe
name: org.your_user_name.MyCustomRecipe
displayName: My custom recipe
description: Find instances of List.
recipeList:
- org.openrewrite.java.search.FindTypes:
fullyQualifiedTypeName: java.util.List
checkAssignability: true
```
![](../.gitbook/assets/builder-edit-recipe.png)
{% endcode %}
![](../.gitbook/assets/builder-yaml-preview.png)
1. Click _Import YAML_ to open form
2. Paste in the contents of the recipe above.
![](../.gitbook/assets/builder-import-yaml.png)
3. Click _import_
![](../.gitbook/assets/builder-meta-data.png)
4. Observe the _Recipe List_ now contains our `FindTypes` recipe and configuration
## Step 2: Change options
Once we have imported a recipe from YAML, we can make further modifications before running the recipe.
1. Click the _Settings_ button (Gear) next to `Find Types` to open the recipe editor.
2. Change `java.util.List` to `java.util.Set`
3. Click _Update_
4. Observe in the _Recipe Preview_ on the right side that the recipe configuration updated.
## Step 3: Confirm repository selection
In the _Recipe Meta Data_ form you can select which repositories to run the recipe against.
## Step 4: Run Recipe
Click _Dry Run_ to execute your custom recipe.