Skip to content

fix: ReadMe Gen - Fixed incorrect section reference if non-parent module#7021

Draft
AlexanderSehr wants to merge 3 commits into
Azure:mainfrom
AlexanderSehr:users/alsehr/readmeUsageExamples
Draft

fix: ReadMe Gen - Fixed incorrect section reference if non-parent module#7021
AlexanderSehr wants to merge 3 commits into
Azure:mainfrom
AlexanderSehr:users/alsehr/readmeUsageExamples

Conversation

@AlexanderSehr

@AlexanderSehr AlexanderSehr commented May 9, 2026

Copy link
Copy Markdown
Collaborator

Description

Currently, all child-module readme files would reference the # Usage Examples section, 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:
image

The changes initially visible in this PR show the state after

  • Running on the authorization/role-assignment module folder with the -recurse flag => No change
  • Running on the key-vault/vault module folder with the -recurse flag => Change only in child modules

Pipeline Reference

Pipeline

Type of Change

  • Azure Verified Module updates:
    • Bugfix containing backwards-compatible bug fixes, and I have NOT bumped the MAJOR or MINOR version in version.json:
    • Feature update backwards compatible feature updates, and I have bumped the MINOR version in version.json.
    • Breaking changes and I have bumped the MAJOR version in version.json.
    • Update to documentation
  • Update to CI Environment or utilities (Non-module affecting changes)

@AlexanderSehr AlexanderSehr added the Type: CI 🚀 This issue is related to the AVM CI label May 9, 2026
@microsoft-github-policy-service microsoft-github-policy-service Bot added the Needs: Triage 🔍 Maintainers need to triage still label May 9, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown

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.

@microsoft-github-policy-service

Copy link
Copy Markdown

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!

@AlexanderSehr AlexanderSehr added Type: Bug 🐛 Something isn't working Needs: Core Team 🧞 This item needs the AVM Core Team to review it labels May 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs: Core Team 🧞 This item needs the AVM Core Team to review it Needs: Triage 🔍 Maintainers need to triage still Type: Bug 🐛 Something isn't working Type: CI 🚀 This issue is related to the AVM CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant