Repository navigation
Show optional recipe options in the Moderne CLI run instructions - #553
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Recipe pages only show
--recipe-optionflags when a recipe has a required option, and then mix the optional examples into the command you need to run. Recipes with only optional options, likeAddOciLabels, get a baremod run. This brings over the change from moderneinc/moderne-docs#1052:RunRecipetakes a newoptionalCliOptionsprop. When it's set, the Moderne CLI tab keeps the plain run command and adds a second one, with each option on its own line and labelled as example values.The generator side is openrewrite/rewrite-recipe-markdown-generator#389. This needs to merge first, or recipes with required options lose their optional examples from the run command at the next full regeneration. Until then, pages render exactly as before.