add WhatIf parameter to the pipeline

Author: anamnavi

.pipelines/PowerShell-Docker-Image-Build-Official.yml

@@ -5,6 +5,10 @@ parameters:
   default: 'v7.4.0-preview.5'
 - name: 'releaseChannel'
   default: 'preview'
+- name: 'whatIf'
+  displayName: 'Skip publishing to MCR, but show what would get published and attached'
+  type: boolean
+  default: false  
 variables:
 - name: POWERSHELL_TELEMETRY_OPTOUT
   value: 1
@@ -16,6 +20,8 @@ variables:
   value: ${{ parameters.releaseChannel }}
 - name: releaseChannelPath
   value: ''
+- name: whatIf
+  value: ${{ parameters.whatIf }}
 - name: runCodesignValidationInjection
   value: false
 - name: DisableDockerDetector
@@ -129,6 +135,7 @@ extends:
             $info = @{}
             $info.Add("channel", $env:RELEASECHANNEL)
             $info.Add("releaseVersionTag", $env:RELEASEVERSIONTAG)
+            $info.Add("whatIf", $env:WHATIF)
             $info | ConvertTo-Json | Out-File -Encoding utf8NoBOM -FilePath ./BuildInfo.json
           displayName: 'Write build info to file'
         - task: CopyFiles@2

.pipelines/PowerShell-Docker-Image-Release-Official.yml

@@ -63,9 +63,11 @@ extends:
             $currentChannel = $($buildMetadata.channel)
             $currentVersion = $($buildMetadata.releaseVersionTag)
             $finalVersion = $currentVersion.Trim("v")
-            Write-Verbose -Verbose "version: $finalVersion and channel: $currentChannel"
+            $whatIfSwitch = $($buildMetadata.whatIf)
+            Write-Verbose -Verbose "version: $finalVersion and channel: $currentChannel and whatIf: $whatIf"
             Write-Host "##vso[task.setvariable variable=channel;isOutput=true]$currentChannel"
             Write-Host "##vso[task.setvariable variable=version;isOutput=true]$finalVersion"
+            Write-Host "##vso[task.setvariable variable=whatIf;isOutput=true]$whatIfSwitch"
           displayName: 'Get channel from buildInfo.json'
           name: setChannelStep
       - job: DownloadImageArtifactFromBuild
@@ -275,6 +277,8 @@ extends:
           value: $[ stageDependencies.GetBuildArtifacts.DownloadMetaArtifactFromBuild.outputs['setChannelStep.channel'] ]
         - name: version
           value: $[ stageDependencies.GetBuildArtifacts.DownloadMetaArtifactFromBuild.outputs['setChannelStep.version'] ]
+        - name: whatIf
+          value: $[ stageDependencies.GetBuildArtifacts.DownloadMetaArtifactFromBuild.outputs['setChannelStep.whatIf'] ]
         pool:
           timeoutInMinutes: 30
           type: windows
@@ -299,6 +303,7 @@ extends:
             $pathToImageMetadataFile = Join-Path -Path $pathToParametersFolder -ChildPath 'ImageMetadata.json'
             $pathToChannelJsonFile = Join-Path -Path $pathToParametersFolder -ChildPath 'ChannelInfo.json'
             $currentChannel = '$(channel)'
+            $currentWhatIfSwitch = '$(whatIf)'
 
             $channelHash = @{channel=$currentChannel}
             $channelHash | ConvertTo-Json | Out-File $pathToChannelJsonFile

EV2Specs/ServiceGroupRoot/Shell/Run/Run.ps1

@@ -123,6 +123,7 @@ try {
     Write-Verbose -Verbose "Getting channel info"
     $channelJsonFileContent = Get-Content -Path $pathToChannelJson | ConvertFrom-Json
     $channel = $channelJsonFileContent.channel
+    $whatIf = $channelJsonFileContent.whatIf
 
     Write-Verbose -Verbose "Getting image info"
     $imgJsonFileContent = Get-Content -Path $pathToImgMetadataJson | ConvertFrom-Json
@@ -169,18 +170,38 @@ try {
                         # Import (old) image by digest from MCR into our ACR
                         $mcrImageNameDigest = "mcr.microsoft.com/powershell@$imageDigest"
                         $acrEOLImageTag = "$tag-EOL"
-                        az acr import --name $env:DESTINATION_ACR_NAME --source $mcrImageNameDigest --image $acrEOLImageTag
+                        if (!$whatIf)
+                        {
+                            az acr import --name $env:DESTINATION_ACR_NAME --source $mcrImageNameDigest --image $acrEOLImageTag
+                        }
+                        else {
+                            Write-Verbose -Verbose "az acr import --name $env:DESTINATION_ACR_NAME --source $mcrImageNameDigest --image $acrEOLImageTag"
+                        }
 
                         # Attach lifecycle annotation, which will eventually get synced to MCR
                         $acrImageNameDigest = "$env:DESTINATION_ACR_NAME.azurecr.io/public/powershell@$imageDigest"
-                        oras attach --artifact-type "application/vnd.microsoft.artifact.lifecycle" --annotation "vnd.microsoft.artifact.lifecycle.end-of-life.date=$endOfLifeDate" $acrImageNameDigest
+                        if (!$whatIf)
+                        {
+                            oras attach --artifact-type "application/vnd.microsoft.artifact.lifecycle" --annotation "vnd.microsoft.artifact.lifecycle.end-of-life.date=$endOfLifeDate" $acrImageNameDigest
+                        }
+                        else {
+                            Write-Verbose -Verbose "oras attach --artifact-type `"application/vnd.microsoft.artifact.lifecycle`" --annotation `"vnd.microsoft.artifact.lifecycle.end-of-life.date=$endOfLifeDate`" $acrImageNameDigest"
+                        }
+                        
                     }
 
                     # Need to push image for each tag
                     $destination_image_full_name = "$env:DESTINATION_ACR_NAME.azurecr.io/public/powershell:${tag}"
                     Write-Verbose -Verbose "dest img full name: $destination_image_full_name"
                     Write-Verbose -Verbose "Pushing file $tarballFilePath to $destination_image_full_name"
-                    ./crane push $tarballFilePath $destination_image_full_name
+                    if (!$whatIf)
+                    {
+                        ./crane push $tarballFilePath $destination_image_full_name
+                    }
+                    else {
+                        Write-Verbose "./crane push $tarballFilePath $destination_image_full_name"
+                    }
+                    
                     Write-Verbose -Verbose "done pushing for tag: $tag"
                 }
             }