Skip to content

Document the generateRecipeCsv goal#468

Merged
Jenson3210 merged 3 commits intomasterfrom
add-generateRecipeCsv-goal-docs
Mar 4, 2026
Merged

Document the generateRecipeCsv goal#468
Jenson3210 merged 3 commits intomasterfrom
add-generateRecipeCsv-goal-docs

Conversation

@Jenson3210
Copy link
Contributor

@Jenson3210 Jenson3210 commented Mar 2, 2026

Summary

  • Add rewrite:generateRecipeCsv to the goals list in the Maven plugin reference
  • Add a dedicated section describing the goal's behavior

Context

Add the new rewrite:generateRecipeCsv goal to the goals list and add a
dedicated section describing its behavior. This goal is the Maven
equivalent of the Gradle recipeCsvGenerate task, added in
openrewrite/rewrite-maven-plugin#1113.
Copy link
Contributor

@mike-solomon mike-solomon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - couple of minor comments below.


## The "recipeCsvGenerate" goal

Execute `mvn rewrite:recipeCsvGenerate` to generate a `recipes.csv` marketplace file from the recipes found in this project. This is the Maven equivalent of the Gradle `recipeCsvGenerate` task provided by the [OpenRewrite Gradle build plugin](https://github.com/openrewrite/rewrite-build-gradle-plugin).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure an OpenRewrite user would know what a "marketplace file" is. Do you think that's important to include? I know there's an info section below that talks about this - but I could see people being confused right here. Maybe we should just add the Moderne link on marketplace file here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added a link here

To find out what recipes a rewrite module provides, see its documentation and the output of the `rewrite:discover` goal.
:::

## The "recipeCsvGenerate" goal
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very minor - but it is a bit weird to me that this section comes before the type table section when it comes after the typetable in the previous section.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! moved the section

@github-project-automation github-project-automation bot moved this from In Progress to Ready to Review in OpenRewrite Mar 2, 2026
Removed duplicate section for the 'TypeTable' goal and clarified the 'recipeCsvGenerate' goal description.
@Jenson3210 Jenson3210 merged commit cb67540 into master Mar 4, 2026
@Jenson3210 Jenson3210 deleted the add-generateRecipeCsv-goal-docs branch March 4, 2026 08:42
@github-project-automation github-project-automation bot moved this from Ready to Review to Done in OpenRewrite Mar 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants