feat: Added 'Publish from tag' pipeline for AVM

.github/actions/templates/avm-publishModule/action.yml

@@ -56,9 +56,6 @@ runs:
           # Load used functions
           . (Join-Path $env:GITHUB_WORKSPACE 'avm' 'utilities' 'pipelines'  'publish' 'Publish-ModuleFromPathToPBR.ps1')
 
-          ################################
-          ##   Get modules to publish   ##
-          ################################
           $functionInput = @{
             TemplateFilePath     = Join-Path $env:GITHUB_WORKSPACE "${{ inputs.templateFilePath }}"
             PublicRegistryServer = ConvertTo-SecureString '${{ env.PUBLISH_REGISTRY_SERVER }}' -AsPlainText -Force
@@ -67,7 +64,6 @@ runs:
           Write-Verbose "Invoke function with" -Verbose
           Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
 
-          # Get the modified child resources
           Publish-ModuleFromPathToPBR @functionInput -Verbose
 
           Write-Output '::endgroup::'

.github/workflows/avm.platform.publish.tag.yml

@@ -0,0 +1,63 @@
+name: "avm.platform.publish-tag"
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "The git tag of the module to publish."
+        required: true
+        type: string
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  job_publish_module_with_tag:
+    runs-on: ubuntu-latest
+    name: "Publish module with tag"
+    steps:
+      - name: Checkout tag
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.inputs.tag }}
+
+      - name: Log in to Azure
+        uses: azure/login@v1
+        with:
+          client-id: ${{ env.PUBLISH_CLIENT_ID }}
+          tenant-id: ${{ env.PUBLISH_TENANT_ID }}
+          subscription-id: ${{ env.PUBLISH_SUBSCRIPTION_ID }}
+
+      # Adding a step to explicitly install the latest Bicep CLI because there is
+      # always a delay in updating Bicep CLI in the job runner environments.
+      - name: Install the latest Bicep CLI
+        shell: bash
+        run: |
+          curl -Lo bicep https://github.com/Azure/bicep/releases/latest/download/bicep-linux-x64
+          chmod +x ./bicep
+          sudo mv ./bicep /usr/local/bin/bicep
+          bicep --version
+
+      - name: "Publish tagged module to public bicep registry"
+        uses: azure/powershell@v1
+        with:
+          azPSVersion: "latest"
+          inlineScript: |
+            # Grouping task logs
+            Write-Output '::group::Publish tagged module to public bicep registry'
+
+            # Load used functions
+            . (Join-Path $env:GITHUB_WORKSPACE 'avm' 'utilities' 'pipelines'  'publish' 'Publish-ModuleFromTagToPBR.ps1')
+
+            $functionInput = @{
+              ModuleReleaseTagName = '${{ github.event.inputs.tag }}'
+              PublicRegistryServer = ConvertTo-SecureString '${{ secrets.PUBLISH_REGISTRY_SERVER }}' -AsPlainText -Force
+            }
+
+            Write-Verbose "Invoke function with" -Verbose
+            Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose
+
+            Publish-ModuleFromTagToPBR @functionInput -Verbose
+
+            Write-Output '::endgroup::'

avm/utilities/pipelines/publish/Publish-ModuleFromTagToPBR.ps1

@@ -1,66 +1,62 @@
+<#
+.SYNOPSIS
+Publish a module based on the provided git tag
+
+.DESCRIPTION
+Publish a module based on the provided git tag
+
+.PARAMETER ModuleReleaseTagName
+Mandatory. The git tag to identify the module with & publish its code state of
+
+.PARAMETER PublicRegistryServer
+Mandatory. The public registry server.
+
+.EXAMPLE
+Publish-ModuleFromTagToPBR -ModuleReleaseTagName 'avm/res/key-vault/vault/0.3.0' -PublicRegistryServer (ConvertTo-SecureString 'myServer' -AsPlainText -Force)
+
+Publish the module 'avm/res/key-vault/vault' of git tag 'avm/res/key-vault/vault/0.3.0' to the public registry server 'myServer'
+#>
 function Publish-ModuleFromTagToPBR {
 
-  [CmdletBinding()]
+  [CmdletBinding(SupportsShouldProcess)]
   param (
-    [Parameter(Mandatory = $true)]
+    [Parameter(Mandatory)]
     [string] $ModuleReleaseTagName,
 
-    [Parameter(Mandatory = $true)]
+    [Parameter(Mandatory)]
     [secureString] $PublicRegistryServer
   )
 
   # Load used functions
-  . (Join-Path $PSScriptRoot 'helper' 'Get-BRMRepositoryName.ps1')
   . (Join-Path $PSScriptRoot 'helper' 'Get-ModuleReadmeLink.ps1')
-  . (Join-Path (Split-Path $PSScriptRoot -Parent) 'sharedScripts' 'tokenReplacement' 'Convert-TokensInFileList.ps1')
-
-  # TODO: Diff in between tag & tag^-1 to find modules to publish?
 
   # 1. Find tag as per function input
-  $repositoryRoot = (Get-Item $PSScriptRoot).Parent.Parent.Parent.Parent.Parent
+  $repositoryRoot = (Get-Item $PSScriptRoot).Parent.Parent.Parent.Parent.Parent.FullName
   $targetVersion = Split-Path $ModuleReleaseTagName -Leaf
   $moduleRelativeFolderPath = $ModuleReleaseTagName -replace "\/$targetVersion$", ''
   $moduleFolderPath = Join-Path $repositoryRoot $moduleRelativeFolderPath
   $moduleJsonFilePath = Join-Path $moduleFolderPath 'main.json'
+  Write-Verbose "Determined JSON template Path [$moduleJsonFilePath]"
 
-
-  # 2. Get Target Published Module Name
-  $publishedModuleName = Get-BRMRepositoryName -TemplateFilePath $moduleJsonFilePath
-
-  # 3. Get the documentation link
-  $documentationUri = Get-ModuleReadmeLink -TagName $ModuleReleaseTagName -ModuleRelativeFolderPath $moduleRelativeFolderPath
-
-  # 4. Replace telemetry version value (in JSON)
-  $tokenConfiguration = @{
-    FilePathList   = @($moduleJsonFilePath)
-    AbsoluteTokens = @{
-      '-..--..-' = $targetVersion
-    }
-  }
-  $null = Convert-TokensInFileList @tokenConfiguration
-
-  # Double-check that tokens are correctly replaced
-  $templateContent = Get-Content -Path $moduleJsonFilePath
-  $incorrectLines = @()
-  for ($index = 0; $index -lt $templateContent.Count; $index++) {
-    if ($templateContent[$index] -match '-..--..-') {
-      $incorrectLines += ('You have the token [{0}] in line [{1}] of file [{2}]. Please seek advice from the AVM team.' -f $matches[0], ($index + 1), $moduleJsonFilePath)
-    }
-  }
-  if ($incorrectLines) {
-    throw ($incorrectLines | ConvertTo-Json)
-  }
+  # 2. Get the documentation link
+  $documentationUri = Get-ModuleReadmeLink -TagName $ModuleReleaseTagName -ModuleFolderPath $moduleFolderPath
+  Write-Verbose "Determined documentation URI [$documentationUri]"
 
   ###################
-  ## 5.  Publish   ##
+  ## 3.  Publish   ##
   ###################
   $plainPublicRegistryServer = ConvertFrom-SecureString $PublicRegistryServer -AsPlainText
 
   $publishInput = @(
     $moduleJsonFilePath
-    '--target', ("br:{0}/public/bicep/{1}:{2}" -f $plainPublicRegistryServer, $publishedModuleName, $targetVersion)
+    '--target', ("br:{0}/public/bicep/{1}:{2}" -f $plainPublicRegistryServer, $moduleRelativeFolderPath, $targetVersion)
     '--documentationUri', $documentationUri
     '--force'
   )
-  # bicep publish @publishInput
+
+  Write-Verbose "Publish Input:`n $($publishInput | ConvertTo-Json -Depth 10)" -Verbose
+
+  if ($PSCmdlet.ShouldProcess("Module of tag [$ModuleReleaseTagName]", "Publish")) {
+    bicep publish @publishInput
+  }
 }