From d167f6a06cfebc1b0897fba4ab2dcf8609f8c208 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Sat, 9 May 2026 20:11:57 +0200 Subject: [PATCH 1/3] Update to latest --- utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 804d7af768c..5a0da5764a2 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -2080,7 +2080,7 @@ function Initialize-ReadMe { ' params: { (...) }', '}', '```', - 'For examples, please refer to the [Usage Examples](#usage-examples) section.' + 'For examples, please refer to the main module''s _Usage Examples_ section.' ) } From f3d24772f358b4d587d8852468ea7c34eebdcab8 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Sat, 9 May 2026 20:20:04 +0200 Subject: [PATCH 2/3] Update to latest --- .../sharedScripts/Set-ModuleReadMe.ps1 | 20 +++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 5a0da5764a2..6f87738e1d6 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -1983,6 +1983,9 @@ Mandatory. The template file content object to crawl data from .PARAMETER ForceCacheRefresh Optional. Define whether or not to force refresh cache data. Note, the cache automatically expires after 1 day. +.PARAMETER IsParentModule +Optional. Configures whether the module has any usages examples in its readme worth referencing + .EXAMPLE Initialize-ReadMe -ReadMeFilePath 'C:/ResourceModules/modules/sql/managed-instances/administrators/readme.md' -FullModuleIdentifier 'sql/managed-instance/administrator' -TemplateFileContent @{ resource = @{}; ... } @@ -2004,6 +2007,9 @@ function Initialize-ReadMe { [Parameter(Mandatory = $true)] [hashtable] $TemplateFileContent, + [Parameter(Mandatory = $true)] + [bool] $HasUsageExamples, + [Parameter()] [switch] $ForceCacheRefresh ) @@ -2080,7 +2086,7 @@ function Initialize-ReadMe { ' params: { (...) }', '}', '```', - 'For examples, please refer to the main module''s _Usage Examples_ section.' + $HasUsageExamples ? 'For examples, please refer to the [Usage Examples](#usage-examples) section.' : 'For examples, please refer to the main module''s _Usage Examples_ section.' ) } @@ -2280,6 +2286,12 @@ function Set-ModuleReadMe { $notes = @() } + $isMultiScopeChildModule = $moduleRoot -match '[\/|\\](rg|sub|mg)\-scope$' + $isMultiScopeParentModule = ((Get-ChildItem -Directory -Path $moduleRoot) | Where-Object { $_.FullName -match '[\/|\\](rg|sub|mg)\-scope$' }).Count -gt 0 + + # If it's multi-scope child module, we need to check if its parent has tests + $hasTests = (Get-ChildItem -Path ($isMultiScopeChildModule ? (Split-Path $moduleRoot) : $moduleRoot) -Recurse -Filter 'main.test.bicep' -File -Force).count -gt 0 + # Initialize readme $inputObject = @{ ReadMeFilePath = $ReadMeFilePath @@ -2287,6 +2299,7 @@ function Set-ModuleReadMe { TemplateFileContent = $templateFileContent TemplateFilePath = $TemplateFilePath ForceCacheRefresh = $ForceCacheRefresh + HasUsageExamples = $hasTests } $readMeFileContent = Initialize-ReadMe @inputObject @@ -2303,11 +2316,6 @@ function Set-ModuleReadMe { $readMeFileContent = Set-ResourceTypesSection @inputObject } - $isMultiScopeChildModule = $moduleRoot -match '[\/|\\](rg|sub|mg)\-scope$' - $isMultiScopeParentModule = ((Get-ChildItem -Directory -Path $moduleRoot) | Where-Object { $_.FullName -match '[\/|\\](rg|sub|mg)\-scope$' }).Count -gt 0 - - # If it's multi-scope child module, we need to check if its parent has tests - $hasTests = (Get-ChildItem -Path ($isMultiScopeChildModule ? (Split-Path $moduleRoot) : $moduleRoot) -Recurse -Filter 'main.test.bicep' -File -Force).count -gt 0 if ($SectionsToRefresh -contains 'Usage examples' -and $hasTests) { # Handle [Usage examples] section From fc0b258cf6731a45dfe555712c9222bbc8655874 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Sat, 9 May 2026 20:51:20 +0200 Subject: [PATCH 3/3] Update to latest --- avm/res/key-vault/vault/access-policy/README.md | 2 +- avm/res/key-vault/vault/key/README.md | 2 +- avm/res/key-vault/vault/secret/README.md | 2 +- utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/avm/res/key-vault/vault/access-policy/README.md b/avm/res/key-vault/vault/access-policy/README.md index d2062d1225b..1846c053dbb 100644 --- a/avm/res/key-vault/vault/access-policy/README.md +++ b/avm/res/key-vault/vault/access-policy/README.md @@ -8,7 +8,7 @@ module vault 'br/public:avm/res/key-vault/vault/access-policy:' = { params: { (...) } } ``` -For examples, please refer to the [Usage Examples](#usage-examples) section. +For examples, please refer to the main module's _Usage Examples_ section. ## Navigation diff --git a/avm/res/key-vault/vault/key/README.md b/avm/res/key-vault/vault/key/README.md index 268ee9b87f8..e6c6808de2e 100644 --- a/avm/res/key-vault/vault/key/README.md +++ b/avm/res/key-vault/vault/key/README.md @@ -8,7 +8,7 @@ module vault 'br/public:avm/res/key-vault/vault/key:' = { params: { (...) } } ``` -For examples, please refer to the [Usage Examples](#usage-examples) section. +For examples, please refer to the main module's _Usage Examples_ section. ## Navigation diff --git a/avm/res/key-vault/vault/secret/README.md b/avm/res/key-vault/vault/secret/README.md index fe41136a017..3ce944a6673 100644 --- a/avm/res/key-vault/vault/secret/README.md +++ b/avm/res/key-vault/vault/secret/README.md @@ -8,7 +8,7 @@ module vault 'br/public:avm/res/key-vault/vault/secret:' = { params: { (...) } } ``` -For examples, please refer to the [Usage Examples](#usage-examples) section. +For examples, please refer to the main module's _Usage Examples_ section. ## Navigation diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 6f87738e1d6..8b6dbf16226 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -2086,7 +2086,7 @@ function Initialize-ReadMe { ' params: { (...) }', '}', '```', - $HasUsageExamples ? 'For examples, please refer to the [Usage Examples](#usage-examples) section.' : 'For examples, please refer to the main module''s _Usage Examples_ section.' + ($HasUsageExamples ? 'For examples, please refer to the [Usage Examples](#usage-examples) section.' : 'For examples, please refer to the main module''s _Usage Examples_ section.') ) }