Explain root categories in the YAML format reference - #537
Merged
Conversation
Document how a recipe name maps to a catalog path, what root: true actually does, and that multi-segment reverse DNS prefixes need a root category per level.
github-project-automation
Bot
moved this from In Progress
to Ready to Review
in OpenRewrite
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
2 participants
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.
The Categories section listed the keys but never explained how a recipe ends up in a category, which made the fix for a customer publishing under
uk.co.acmehard to self-discover.Adds two subsections: how a recipe name maps to a catalog path (segments matched against the full partial package, unmatched segments synthesized as capitalized names), and what
root: truereally does — the category is not rendered and its children are hoisted, so a multi-segment reverse DNS prefix needs a root per level (ukanduk.co), with a workeduk.co.acmeexample. Also corrects therootrow in the key table, which claimed the opposite ofCategoryTree.getCategories(), and notes that a segment likenomust be quoted.core-categories.yml.