[Utilities] Implemented several improvments for readme script (#4134)

* First readme update * tested changes * Remvoed file deletion * Added URL test retry * Added support for orphaned & moved readmes * Ran readme utility
Azure · Oct 22, 2023 · 29b06f4 · 29b06f4
1 parent 4ceedd1
commit 29b06f4
Show file tree

Hide file tree

Showing 8 changed files with 206 additions and 336 deletions.
diff --git a/modules/compute/ssh-public-key/README.md b/modules/compute/ssh-public-key/README.md
@@ -1,5 +1,7 @@
 # Public SSH Keys `[Microsoft.Compute/sshPublicKeys]`
 
+> This module has already been migrated to [AVM](https://github.com/Azure/bicep-registry-modules/tree/main/avm/res). Only the AVM version is expected to receive updates / new features. Please do not work on improving this module in [CARML](https://aka.ms/carml).
+
 This module deploys a Public SSH Key.
 
 > Note: The resource does not auto-generate the key for you.

diff --git a/modules/key-vault/vault/README.md b/modules/key-vault/vault/README.md
@@ -1,5 +1,7 @@
 # Key Vaults `[Microsoft.KeyVault/vaults]`
 
+> This module has already been migrated to [AVM](https://github.com/Azure/bicep-registry-modules/tree/main/avm/res). Only the AVM version is expected to receive updates / new features. Please do not work on improving this module in [CARML](https://aka.ms/carml).
+
 This module deploys a Key Vault.
 
 ## Navigation

diff --git a/modules/kubernetes-configuration/extension/README.md b/modules/kubernetes-configuration/extension/README.md
@@ -1,5 +1,7 @@
 # Kubernetes Configuration Extensions `[Microsoft.KubernetesConfiguration/extensions]`
 
+> This module has already been migrated to [AVM](https://github.com/Azure/bicep-registry-modules/tree/main/avm/res). Only the AVM version is expected to receive updates / new features. Please do not work on improving this module in [CARML](https://aka.ms/carml).
+
 This module deploys a Kubernetes Configuration Extension.
 
 ## Navigation

diff --git a/modules/kubernetes-configuration/flux-configuration/README.md b/modules/kubernetes-configuration/flux-configuration/README.md
@@ -1,5 +1,7 @@
 # Kubernetes Configuration Flux Configurations `[Microsoft.KubernetesConfiguration/fluxConfigurations]`
 
+> This module has already been migrated to [AVM](https://github.com/Azure/bicep-registry-modules/tree/main/avm/res). Only the AVM version is expected to receive updates / new features. Please do not work on improving this module in [CARML](https://aka.ms/carml).
+
 This module deploys a Kubernetes Configuration Flux Configuration.
 
 ## Navigation

diff --git a/modules/network/private-endpoint/README.md b/modules/network/private-endpoint/README.md
@@ -1,5 +1,7 @@
 # Private Endpoints `[Microsoft.Network/privateEndpoints]`
 
+> This module has already been migrated to [AVM](https://github.com/Azure/bicep-registry-modules/tree/main/avm/res). Only the AVM version is expected to receive updates / new features. Please do not work on improving this module in [CARML](https://aka.ms/carml).
+
 This module deploys a Private Endpoint.
 
 ## Navigation

diff --git a/modules/network/public-ip-address/README.md b/modules/network/public-ip-address/README.md
@@ -1,5 +1,7 @@
 # Public IP Addresses `[Microsoft.Network/publicIPAddresses]`
 
+> This module has already been migrated to [AVM](https://github.com/Azure/bicep-registry-modules/tree/main/avm/res). Only the AVM version is expected to receive updates / new features. Please do not work on improving this module in [CARML](https://aka.ms/carml).
+
 This module deploys a Public IP Address.
 
 ## Navigation

diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1
diff --git a/utilities/tools/Set-Module.ps1 b/utilities/tools/Set-Module.ps1
@@ -132,11 +132,11 @@ function Set-Module {
                 ################
                 if (-not $using:SkipReadMe) {
                     Write-Output "Generating readme for [$resourceTypeIdentifier]"
-                    . $using:ReadMeScriptFilePath
 
                     # If the template was just build, we can pass the JSON into the readme script to be more efficient
                     $readmeTemplateFilePath = (-not $using:SkipBuild) ? (Join-Path (Split-Path $_ -Parent) 'main.json') : $_
 
+                    . $using:ReadMeScriptFilePath
                     Set-ModuleReadMe -TemplateFilePath $readmeTemplateFilePath -CrossReferencedModuleList $using:crossReferencedModuleList
                 }
             }