Add support for firstwhatif deployment to github

Author: oZakari

alz/github/actions/bicep-avm/templates/actions/bicep-avm-deploy/action.yaml

@@ -26,6 +26,10 @@ inputs:
   deploymentType:
     description: 'The deployment type (managementGroup, subscription, resourceGroup)'
     required: true
+  firstRunWhatIf:
+    description: 'Run a what-if on the first run'
+    required: false
+    default: 'false'
   networkType:
     description: 'The network type filter'
     required: false
@@ -46,6 +50,22 @@ runs:
           $deploymentType = $env:DEPLOYMENT_TYPE
           $whatIfEnabled = $env:WHAT_IF_ENABLED -eq 'true'
 
+          # Check if we should skip what-if for first deployment
+          $firstDeploymentString = $env:firstDeployment
+          $firstDeployment = $true
+          if($firstDeploymentString -eq "") {
+            $firstDeployment = $false
+          } else {
+            $firstDeployment = [System.Convert]::ToBoolean($firstDeploymentString)
+          }
+
+          $firstRunWhatIf = [System.Convert]::ToBoolean($env:FIRST_RUN_WHAT_IF)
+
+          if($whatIfEnabled -and $firstDeployment -and !$firstRunWhatIf) {
+            Write-Warning "Skipping the What-If check as the deployment is dependent on resources that do not exist yet..."
+            exit 0
+          }
+
           # Generate deployment name with timestamp (matching classic bicep pattern)
           $deploymentPrefix = "alz"
           $deploymentNameBase = $env:DISPLAY_NAME.Replace(" ", "-")
@@ -255,4 +275,5 @@ runs:
         RESOURCE_GROUP_NAME: $${{ inputs.resourceGroupName }}
         LOCATION: $${{ inputs.location }}
         DEPLOYMENT_TYPE: $${{ inputs.deploymentType }}
+        FIRST_RUN_WHAT_IF: $${{ inputs.firstRunWhatIf }}
         WHAT_IF_ENABLED: $${{ inputs.whatIfEnabled }}

alz/github/actions/bicep-avm/templates/workflows/cd-template.yaml

@@ -51,6 +51,11 @@ jobs:
           subscription-id: $${{ vars.AZURE_SUBSCRIPTION_ID }}
           enable-AzPSSession: true
 
+      - name: Check for First Deployment
+        uses: ${organization_name}/${repository_name_templates}/.github/actions/bicep-avm-first-deployment-check@main
+        with:
+          managementGroupId: $${{ env.MANAGEMENT_GROUP_ID }}
+
 %{ for script_file in script_files ~}
 %{ if try(script_file.networkType, "") != "" ~}
       - name: 'Plan: ${script_file.displayName} (Network Type: ${script_file.networkType})'
@@ -65,6 +70,7 @@ jobs:
           resourceGroupName: '${script_file.resourceGroupNameVariable}'
           location: '$${{ env.LOCATION }}'
           deploymentType: '${script_file.deploymentType}'
+          firstRunWhatIf: '${script_file.firstRunWhatIf}'
           networkType: '${script_file.networkType}'
           whatIfEnabled: 'true'
 %{ else ~}
@@ -80,6 +86,7 @@ jobs:
           resourceGroupName: '${script_file.resourceGroupNameVariable}'
           location: '$${{ env.LOCATION }}'
           deploymentType: '${script_file.deploymentType}'
+          firstRunWhatIf: '${script_file.firstRunWhatIf}'
           whatIfEnabled: 'true'
 %{ endif ~}
 %{ endfor ~}

alz/github/actions/bicep-avm/templates/workflows/ci-template.yaml

@@ -71,6 +71,11 @@ jobs:
           tenant-id: $${{ vars.AZURE_TENANT_ID }}
           subscription-id: $${{ vars.AZURE_SUBSCRIPTION_ID }}
           enable-AzPSSession: true
+
+      - name: Check for First Deployment
+        uses: ${organization_name}/${repository_name_templates}/.github/actions/bicep-avm-first-deployment-check@main
+        with:
+          managementGroupId: $${{ env.MANAGEMENT_GROUP_ID }}
 %{ for script_file in script_files ~}
 
       - name: 'What If: ${script_file.displayName}'
@@ -84,5 +89,6 @@ jobs:
           resourceGroupName: '${script_file.resourceGroupNameVariable}'
           location: '$${{ env.LOCATION }}'
           deploymentType: '${script_file.deploymentType}'
+          firstRunWhatIf: '${script_file.firstRunWhatIf}'
           whatIfEnabled: 'true'
 %{ endfor ~}

alz/github/locals.files.tf

@@ -37,7 +37,7 @@ locals {
     subscriptionIdVariable     = try("$${{ env.${script_file.subscriptionId} }}", "")
     resourceGroupNameVariable  = try("$${{ env.${script_file.resourceGroupName} }}", "")
     deploymentType             = script_file.deploymentType
-    firstRunWhatIf             = local.is_classic_bicep ? script_file.firstRunWhatIf : null
+    firstRunWhatIf             = script_file.firstRunWhatIf
     group                      = script_file.group
     networkType                = try(script_file.networkType, "")
   } if try(script_file.networkType, "") == "" || try(script_file.networkType, "") == local.networking_type } : {}