replace visibility handling in recipes with CLI-specific implementation by KamilPatora · Pull Request #144 · allegro/allwrite

KamilPatora · 2026-07-30T14:03:29Z

Refactor Recipe Discovery

Summary

Replace the RecipeVisibility.PUBLIC/INTERNAL model with an explicit CliAllwriteRecipe base class.

Changes

Add CliAllwriteRecipe with required group and action values.
Return all recipes from RecipeSource.
Filter CLI recipes explicitly in allwrite ls, recipe matching, and shell completions.
Remove the allwrite ls --all option.

Expected Result

User-facing migrations remain available through friendly CLI commands, while internal and option-based recipes are hidden and should be used in migration code

KamilPatora · 2026-07-30T14:42:44Z

 name: pl.allegro.tech.allwrite.recipes.YamlPublicRecipe
 displayName: Public YAML recipe
 tags:
-  - visibility:public


public recipes have to declare group and action (not!) (borat reference)

# Conflicts: # allwrite-recipes/src/main/kotlin/pl/allegro/tech/allwrite/recipes/gradle/ChangeGradleDependency.kt # allwrite-recipes/src/main/kotlin/pl/allegro/tech/allwrite/recipes/spring/ChangeSpringBoot4WebServerTypes.kt

…nto refactor/cli-recipe-discovery

…nents

…Matcher

Copilot

Pull request overview

Replaces visibility-based recipe discovery with explicit CLI recipe metadata.

Changes:

Adds CliAllwriteRecipe and removes RecipeVisibility.
Makes RecipeSource.findAll() return all recipes; CLI consumers filter by coordinates.
Updates recipes, tests, fixtures, completions, and documentation.

Reviewed changes

Copilot reviewed 54 out of 54 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`docs/recipes/index.md`	Documents new recipe helpers.
`docs/index.md`	Adds the CLI base class.
`docs/contributing.md`	Explains recipe discovery and authoring.
`docs/cli.md`	Updates `ls` behavior.
`allwrite-spi/.../RecipeVisibility.kt`	Removes visibility enum.
`allwrite-spi/.../RecipeMetadata.kt`	Removes visibility metadata.
`allwrite-spi/.../CliAllwriteRecipe.kt`	Adds CLI-specific recipe base.
`allwrite-spi/.../AllwriteScanningRecipe.kt`	Removes visibility parameters.
`allwrite-spi/.../AllwriteRecipe.kt`	Simplifies metadata and enables tag extension.
`allwrite-runtime/src/testFixtures/resources/META-INF/rewrite/yaml-public-recipe.yaml`	Uses CLI coordinate tags.
`allwrite-runtime/src/testFixtures/resources/META-INF/rewrite/yaml-internal-recipe.yaml`	Removes visibility tag.
`allwrite-runtime/src/testFixtures/kotlin/.../FakeRecipeSource.kt`	Updates fake discovery behavior and tags.
`allwrite-runtime/src/testFixtures/kotlin/.../FakePostProcessingRecipe.kt`	Removes visibility configuration.
`allwrite-runtime/src/testFixtures/kotlin/.../FakeCompositeRecipe.kt`	Removes visibility configuration.
`allwrite-runtime/src/testFixtures/kotlin/.../KotlinPublicRecipe.kt`	Adds CLI coordinate tags.
`allwrite-runtime/src/testFixtures/kotlin/.../KotlinInternalRecipe.kt`	Removes visibility tag.
`allwrite-runtime/src/testFixtures/java/.../JavaPublicRecipe.java`	Adds CLI coordinate tags.
`allwrite-runtime/src/testFixtures/java/.../JavaInternalRecipe.java`	Removes visibility tag.
`allwrite-runtime/src/test/kotlin/.../RecipeSourceSpec.kt`	Tests complete and CLI-filtered discovery.
`allwrite-runtime/src/test/kotlin/.../RecipeMetadataSpec.kt`	Tests CLI tags and validation.
`allwrite-runtime/src/test/kotlin/.../RecipeCoordinatesSpec.kt`	Tests CLI recipe identification.
`allwrite-runtime/src/main/kotlin/.../OpenrewriteRecipeSource.kt`	Returns all recipe descriptors.
`allwrite-recipes/src/test/kotlin/.../AddVersionCatalogDependencyReferenceTest.kt`	Adapts test recipe construction.
`allwrite-recipes/src/main/kotlin/.../YamlEntryHasValue.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../UnnestProperties.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../ReplaceStatusCodeValue.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../RenameTaskExecutorBean.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../RemoveAnnotatedMethod.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../PreconditionsAwareAddDependency.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../IsolatedSpringRecipe.kt`	Migrates to `CliAllwriteRecipe`.
`allwrite-recipes/src/main/kotlin/.../FindSpringProperty.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../DeleteSpringPropertyWithValue.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../DeleteSpringPropertyFromSpringAnnotations.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../DeleteSpringProperty.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../ChangeSpringPropertyKey.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../AddNonNullableTypeBoundsToSpringRepositories.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../FindProperties.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../ReplaceFactoryWithConstructor.kt`	Adapts base-class construction.
`allwrite-recipes/src/main/kotlin/.../IsolatedJavaRecipe.kt`	Migrates to `CliAllwriteRecipe`.
`allwrite-recipes/src/main/kotlin/.../ChangeRecordField.kt`	Adapts base-class construction.
`allwrite-recipes/src/main/kotlin/.../UpdateGradleDependency.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../ChangeGradleDependency.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/kotlin/.../AddGradleDependency.kt`	Removes visibility configuration.
`allwrite-recipes/src/main/java/.../RemoveUnusedImportsOfType.java`	Removes visibility tags.
`allwrite-completions/src/main/kotlin/.../GenerateCompletionsAnnotationProcessor.kt`	Limits completions to CLI recipes.
`allwrite-cli/src/test/kotlin/.../RecipeMatcherSpec.kt`	Tests non-CLI exclusion.
`allwrite-cli/src/test/kotlin/.../ListRecipesCommandSpec.kt`	Removes `--all` tests.
`allwrite-cli/src/test/kotlin/.../FailingPostProcessingRecipe.kt`	Removes visibility configuration.
`allwrite-cli/src/main/kotlin/.../RunWithDependabotCommand.kt`	Filters Dependabot discovery by CLI tags.
`allwrite-cli/src/main/kotlin/.../RecipeMatcher.kt`	Matches only CLI recipes.
`allwrite-cli/src/main/kotlin/.../ListRecipesCommand.kt`	Lists only CLI recipes and removes `--all`.
`allwrite-api/src/main/kotlin/.../RecipeSource.kt`	Simplifies the discovery API.
`allwrite-api/src/main/kotlin/.../RecipeCoordinates.kt`	Adds CLI detection and exact tag parsing.
`AGENTS.md`	Updates architectural documentation.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copilot

Pull request overview

Copilot reviewed 54 out of 54 changed files in this pull request and generated no new comments.

Suppressed comments (3)

allwrite-runtime/src/testFixtures/kotlin/pl/allegro/tech/allwrite/runtime/fake/FakeRecipeSource.kt:19

findAll() now means “all descriptors” (as implemented by OpenrewriteRecipeSource), but this fake still removes every non-CLI recipe. That makes fake-backed tests diverge from production and causes the new matcher test to pass without exercising RecipeMatcher's own filter because its non-CLI fixture is discarded here first. Return all mapped descriptors from the fake as well.
allwrite-cli/src/main/kotlin/pl/allegro/tech/allwrite/cli/application/RunWithDependabotCommand.kt:67
This filter prevents Dependabot from discovering recipes that have a dependabot-artifact tag but intentionally lack CLI group/action tags. That contradicts the newly documented FQN-only Dependabot support in docs/contributing.md:100-101, and dependabotArtifacts remains available on both non-CLI base classes. The later coordinate conversion and matcher also require CLI tags, so this path needs to select Dependabot recipes independently of CLI coordinates (or the documented/API support must be removed).

        val recipes = recipeSource.findAll().filter { it.isCliRecipe() }

allwrite-cli/src/main/kotlin/pl/allegro/tech/allwrite/cli/application/ListRecipesCommand.kt:17

The command now filters the output to CLI recipes only, but its user-facing help still says “Lists all recipes.” Update the help text so allwrite ls --help accurately describes the changed behavior.

        val recipes = recipeSource.findAll().filter { it.isCliRecipe() }.sortedBy { it.name }

…abot commands

Copilot

Pull request overview

Copilot reviewed 56 out of 56 changed files in this pull request and generated 1 comment.

Suppressed comments (1)

allwrite-cli/src/main/kotlin/pl/allegro/tech/allwrite/cli/application/RunWithDependabotCommand.kt:72

Non-CLI recipes are now executed solely because the artifact tag matches; their from/to tags are never checked against the Dependabot update. Since regular and scanning recipes still expose version metadata, a recipe for (for example) 2→3 will incorrectly run for an unrelated 1→2 bump. Apply the same version-range eligibility check before adding the descriptor name.

                if (matchingRecipe != null && !matchingRecipe.isCliRecipe()) {
                    listOf(matchingRecipe.name)

+                val matchingRecipe = update.findMatchingRecipe(recipes)
+                if (matchingRecipe != null && !matchingRecipe.isCliRecipe()) {
+                    listOf(matchingRecipe.name)


…abot commands

…ter readability

radoslaw-panuszewski

LGTM! (only one question)

radoslaw-panuszewski · 2026-08-20T11:44:05Z

@@ -5,16 +5,13 @@ import org.openrewrite.ScanningRecipe
 public abstract class AllwriteScanningRecipe<T : Any> @JvmOverloads public constructor(


What about CliAllwriteScanningRecipe?

KamilPatora added 3 commits July 30, 2026 16:03

replace visibility handling in recipes with CLI-specific implementation

377162d

Merge branch 'main' into refactor/cli-recipe-discovery

5a73537

klint

48c52fd

KamilPatora commented Jul 30, 2026

View reviewed changes

KamilPatora added 11 commits July 30, 2026 16:55

docs: enhance CLI recipe discovery documentation

a4165cd

Merge branch 'main' into refactor/cli-recipe-discovery

f5ff332

refactor: simplify recipe listing by removing non-CLI option

aa20fdf

Merge branch 'main' into refactor/cli-recipe-discovery

51ebbd2

# Conflicts: # allwrite-recipes/src/main/kotlin/pl/allegro/tech/allwrite/recipes/gradle/ChangeGradleDependency.kt # allwrite-recipes/src/main/kotlin/pl/allegro/tech/allwrite/recipes/spring/ChangeSpringBoot4WebServerTypes.kt

refactor: remove unused import in ChangeGradleDependency.kt

83ffcc6

Merge remote-tracking branch 'origin/refactor/cli-recipe-discovery' i…

6caf19e

…nto refactor/cli-recipe-discovery

refactor: filter recipes to include only CLI recipes in various compo…

3c61f27

…nents

test: add test for ignoring recipes without CLI coordinates in Recipe…

0ba6a01

…Matcher

Merge branch 'main' into refactor/cli-recipe-discovery

08841d8

test: add test for ignoring recipes without CLI coordinates in Recipe…

1fefc69

…Matcher

test: add test for ignoring recipes without CLI coordinates in Recipe…

70774e8

…Matcher

KamilPatora marked this pull request as ready for review August 11, 2026 09:49

KamilPatora requested a balanced review from Copilot August 11, 2026 09:54

Copilot started reviewing on behalf of KamilPatora August 11, 2026 09:55 View session

Copilot AI reviewed Aug 11, 2026

View reviewed changes

Comment thread ...te-runtime/src/testFixtures/kotlin/pl/allegro/tech/allwrite/runtime/fake/FakeRecipeSource.kt Outdated

Comment thread ...ite-cli/src/main/kotlin/pl/allegro/tech/allwrite/cli/application/RunWithDependabotCommand.kt Outdated

KamilPatora requested a balanced review from Copilot August 11, 2026 10:50

Copilot started reviewing on behalf of KamilPatora August 11, 2026 10:51 View session

Copilot AI reviewed Aug 11, 2026

View reviewed changes

refactor: update recipe handling to include non-CLI recipes in Depend…

c68c5dc

…abot commands

KamilPatora requested a balanced review from Copilot August 11, 2026 11:09

Copilot started reviewing on behalf of KamilPatora August 11, 2026 11:09 View session

Copilot AI reviewed Aug 11, 2026

View reviewed changes

Comment thread ...ite-cli/src/main/kotlin/pl/allegro/tech/allwrite/cli/application/RunWithDependabotCommand.kt

Comment on lines +70 to +72

val matchingRecipe = update.findMatchingRecipe(recipes)

if (matchingRecipe != null && !matchingRecipe.isCliRecipe()) {

listOf(matchingRecipe.name)

KamilPatora added 3 commits August 11, 2026 13:13

refactor: update recipe handling to include non-CLI recipes in Depend…

a934732

…abot commands

klint

8c6c47f

refactor: improve formatting in AGENTS.md and contributing.md for bet…

859a852

…ter readability

PawelBalcerek approved these changes Aug 11, 2026

View reviewed changes

radoslaw-panuszewski approved these changes Aug 20, 2026

View reviewed changes

Navigation Menu

Uh oh!

replace visibility handling in recipes with CLI-specific implementation - #144

replace visibility handling in recipes with CLI-specific implementation#144
KamilPatora wants to merge 18 commits into
mainfrom
refactor/cli-recipe-discovery

KamilPatora commented Jul 30, 2026 •

edited

Loading

Uh oh!

KamilPatora Jul 30, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

radoslaw-panuszewski left a comment

Uh oh!

radoslaw-panuszewski Aug 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		@@ -5,16 +5,13 @@ import org.openrewrite.ScanningRecipe
		public abstract class AllwriteScanningRecipe<T : Any> @JvmOverloads public constructor(

Uh oh!

Conversation

KamilPatora commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Refactor Recipe Discovery

Summary

Changes

Expected Result

Uh oh!

KamilPatora Jul 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

radoslaw-panuszewski left a comment

Choose a reason for hiding this comment

Uh oh!

radoslaw-panuszewski Aug 20, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

KamilPatora commented Jul 30, 2026 •

edited

Loading