fix: ReadMe Gen - Fixed incorrect section reference if non-parent module#7021
Draft
AlexanderSehr wants to merge 3 commits into
Draft
fix: ReadMe Gen - Fixed incorrect section reference if non-parent module#7021AlexanderSehr wants to merge 3 commits into
AlexanderSehr wants to merge 3 commits into
Conversation
|
Important The "Needs: Triage 🔍" label must be removed once the triage process is complete! Tip For additional guidance on how to triage this issue/PR, see the BRM Issue Triage documentation. |
|
Important If this is a module-related PR, being submitted by the sole owner of the module, the AVM core team must review and approve it (as module owners can't approve their own PRs). To indicate this PR needs the core team''s attention, apply the "Needs: Core Team 🧞" label! The core team will only review and approve PRs that have this label applied! |
6 tasks
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
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.
Description
Currently, all child-module readme files would reference the
# Usage Examplessection, even though only a subset of modules (most notably parent modules, but also multi-scope modules) actual have this section.The output is now altered accordingly.
Example of the bug:

The changes initially visible in this PR show the state after
-recurseflag => No change-recurseflag => Change only in child modulesPipeline Reference
Type of Change
version.json:version.json.version.json.