feat: Re-added logic to set module version in readme

avm/res/key-vault/vault/README.md

@@ -31,7 +31,7 @@ The following section provides usage examples for the module, which were used to
 
 >**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
 
->**Note**: To reference the module, please use the following syntax `br/public:avm/res/key-vault/vault:<version>`.
+>**Note**: To reference the module, please use the following syntax `br/public:avm/res/key-vault/vault:0.13.3`.
 
 - [Using only defaults](#example-1-using-only-defaults)
 - [With EC key type](#example-2-with-ec-key-type)
@@ -49,7 +49,7 @@ This instance deploys the module with the minimum set of required parameters.
 <summary>via Bicep module</summary>
 
 ```bicep
-module vault 'br/public:avm/res/key-vault/vault:<version>' = {
+module vault 'br/public:avm/res/key-vault/vault:0.13.3' = {
   name: 'vaultDeployment'
   params: {
     // Required parameters
@@ -92,7 +92,7 @@ module vault 'br/public:avm/res/key-vault/vault:<version>' = {
 <summary>via Bicep parameters file</summary>
 
 ```bicep-params
-using 'br/public:avm/res/key-vault/vault:<version>'
+using 'br/public:avm/res/key-vault/vault:0.13.3'
 
 // Required parameters
 param name = 'kvvmin002'
@@ -113,7 +113,7 @@ This instance deploys the module with the parameters needed for an EC key.
 <summary>via Bicep module</summary>
 
 ```bicep
-module vault 'br/public:avm/res/key-vault/vault:<version>' = {
+module vault 'br/public:avm/res/key-vault/vault:0.13.3' = {
   name: 'vaultDeployment'
   params: {
     // Required parameters
@@ -226,7 +226,7 @@ module vault 'br/public:avm/res/key-vault/vault:<version>' = {
 <summary>via Bicep parameters file</summary>
 
 ```bicep-params
-using 'br/public:avm/res/key-vault/vault:<version>'
+using 'br/public:avm/res/key-vault/vault:0.13.3'
 
 // Required parameters
 param name = 'kvvec002'
@@ -281,7 +281,7 @@ This instance deploys the module with most of its features enabled.
 <summary>via Bicep module</summary>
 
 ```bicep
-module vault 'br/public:avm/res/key-vault/vault:<version>' = {
+module vault 'br/public:avm/res/key-vault/vault:0.13.3' = {
   name: 'vaultDeployment'
   params: {
     // Required parameters
@@ -810,7 +810,7 @@ module vault 'br/public:avm/res/key-vault/vault:<version>' = {
 <summary>via Bicep parameters file</summary>
 
 ```bicep-params
-using 'br/public:avm/res/key-vault/vault:<version>'
+using 'br/public:avm/res/key-vault/vault:0.13.3'
 
 // Required parameters
 param name = 'kvvmax002'
@@ -1063,7 +1063,7 @@ This instance deploys the module with the parameters needed for an RSA key.
 <summary>via Bicep module</summary>
 
 ```bicep
-module vault 'br/public:avm/res/key-vault/vault:<version>' = {
+module vault 'br/public:avm/res/key-vault/vault:0.13.3' = {
   name: 'vaultDeployment'
   params: {
     // Required parameters
@@ -1176,7 +1176,7 @@ module vault 'br/public:avm/res/key-vault/vault:<version>' = {
 <summary>via Bicep parameters file</summary>
 
 ```bicep-params
-using 'br/public:avm/res/key-vault/vault:<version>'
+using 'br/public:avm/res/key-vault/vault:0.13.3'
 
 // Required parameters
 param name = 'kvvrsa002'
@@ -1231,7 +1231,7 @@ This instance deploys the module in alignment with the best-practices of the Wel
 <summary>via Bicep module</summary>
 
 ```bicep
-module vault 'br/public:avm/res/key-vault/vault:<version>' = {
+module vault 'br/public:avm/res/key-vault/vault:0.13.3' = {
   name: 'vaultDeployment'
   params: {
     // Required parameters
@@ -1444,7 +1444,7 @@ module vault 'br/public:avm/res/key-vault/vault:<version>' = {
 <summary>via Bicep parameters file</summary>
 
 ```bicep-params
-using 'br/public:avm/res/key-vault/vault:<version>'
+using 'br/public:avm/res/key-vault/vault:0.13.3'
 
 // Required parameters
 param name = 'kvvwaf002'

utilities/pipelines/sharedScripts/Get-PublishedModuleVersionsList.ps1

@@ -36,7 +36,7 @@ function Get-PublishedModuleVersionsList {
             Write-Verbose "Getting available tags at '$tagListUrl' (attempt $($i + 1))..." -Verbose
             $tagListResponse = Invoke-RestMethod -Uri $tagListUrl
             $publishedTags = $tagListResponse.tags | Sort-Object { [Version]$_ } -Culture 'en-US'
-            Write-Verbose "  Found tags: $($publishedTags -join ', ')" -Verbose
+            Write-Verbose "  Found tags: $($publishedTags -join ', ')"
             return $publishedTags
         } catch {
             if ($i -eq 4) {

utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1

@@ -1545,8 +1545,19 @@ function Set-UsageExamplesSection {
         return $ReadMeFileContent
     }
 
-    $brLink = Get-BRMRepositoryName -TemplateFilePath $TemplateFilePath
-    $targetVersion = '<version>'
+    $brLink = Get-BRMRepositoryName -TemplateFilePath (Join-Path $ModuleRoot 'main.bicep')
+    $moduleType = ($brLink -split '\/')[1]
+    $moduleTargetVersion = Get-ModuleTargetVersion -ModuleFolderPath $ModuleRoot
+    if ((Get-ModulesToPublish -ModuleFolderPath $ModuleRoot).Count -ge 1 -or $moduleTargetVersion -eq '0.1.0') {
+        # The module will be published
+        Write-Verbose 'As the module is modified, a new module version is assumed and used in the readme' -Verbose
+        $targetVersion = $moduleTargetVersion
+    } else {
+        # Since the module is not being published, the version remains the same. Let's get the latest published
+        Write-Verbose 'As the module was not modified, the latest published module version remains valid and is used in the readme' -Verbose
+        $publishedTags = Get-PublishedModuleVersionsList -ModuleType $moduleType -ModuleName $FullModuleIdentifier
+        $targetVersion = ($publishedTags | ForEach-Object { [version]$_ } | Sort-Object)[-1]
+    }
 
     # Process content
     $SectionContent = [System.Collections.ArrayList]@(
@@ -2142,6 +2153,9 @@ function Set-ModuleReadMe {
     . (Join-Path $PSScriptRoot 'helper' 'ConvertTo-OrderedHashtable.ps1')
     . (Join-Path $PSScriptRoot 'Get-BRMRepositoryName.ps1')
     . (Join-Path $PSScriptRoot 'helper' 'Get-CrossReferencedModuleList.ps1')
+    . (Join-Path $PSScriptRoot '..' 'publish' 'helper' 'Get-ModuleTargetVersion.ps1')
+    . (Join-Path $PSScriptRoot '..' 'publish' 'helper' 'Get-ModulesToPublish.ps1')
+    . (Join-Path $PSScriptRoot 'Get-PublishedModuleVersionsList.ps1')
 
     # Check template & make full path
     $TemplateFilePath = Resolve-Path -Path $TemplateFilePath -ErrorAction Stop
@@ -2186,23 +2200,25 @@ function Set-ModuleReadMe {
     # ===================== #
     # Read original readme, if any. Then delete it to build from scratch
     if ((Test-Path $ReadMeFilePath) -and -not ([String]::IsNullOrEmpty((Get-Content $ReadMeFilePath -Raw)))) {
-        $readMeFileContent = Get-Content -Path $ReadMeFilePath -Encoding 'utf8'
+        $originalReadMeFileContent = Get-Content -Path $ReadMeFilePath -Encoding 'utf8'
+    } else {
+        $originalReadMeFileContent = @()
     }
     # Make sure we preserve any manual notes a user might have added in the corresponding section
-    if ($match = $readMeFileContent | Select-String -Pattern '## Notes') {
+    if ($match = $originalReadMeFileContent | Select-String -Pattern '## Notes') {
         $startIndex = $match.LineNumber
 
-        if ($readMeFileContent[($startIndex + 1)] -notlike '## *') {
+        if ($originalReadMeFileContent[($startIndex + 1)] -notlike '## *') {
             $endIndex = $startIndex + 1
         } else {
             $endIndex = $startIndex
         }
 
-        while (-not (($endIndex + 1) -gt $readMeFileContent.count) -and $readMeFileContent[($endIndex + 1)] -notlike '## *') {
+        while (-not (($endIndex + 1) -gt $originalReadMeFileContent.count) -and $originalReadMeFileContent[($endIndex + 1)] -notlike '## *') {
             $endIndex++
         }
 
-        $notes = $readMeFileContent[($startIndex - 1)..$endIndex]
+        $notes = $originalReadMeFileContent[($startIndex - 1)..$endIndex]
     } else {
         $notes = @()
     }