Refactor Deployment settings & logic in Deploy and DetermineDeploymentEnvironments actions.

Actions/.Modules/ReadSettings.psm1

@@ -300,7 +300,8 @@ function ReadSettings {
         [string] $repoSettingsVariableValue = "$ENV:ALGoRepoSettings",
         [string] $environmentSettingsVariableValue = "$ENV:ALGoEnvSettings",
         [string] $environmentName = "$ENV:ALGoEnvName",
-        [string] $customSettings = ""
+        [string] $customSettings = "",
+        [string] $githubEnvironmentsJson = ""
     )
 
     # If the build is triggered by a pull request the refname will be the merge branch. To apply conditional settings we need to use the base branch
@@ -549,6 +550,74 @@ function ReadSettings {
         $settings.projectName = $project # Default to project path as project name
     }
 
+    # Environments can come from three places: GitHub repo environments, settings.environments and the environmentName input of the PublishToEnvironment action
+    if ($githubEnvironmentsJson) {
+        $ghEnvironments = $githubEnvironmentsJson | ConvertFrom-Json
+    } else {
+        $ghEnvironments = @()
+    }
+
+    # $ghEnvironments = @(GetGitHubEnvironments)
+    $environments = @($ghEnvironments | ForEach-Object { $_.name }) + @($settings.environments) + @($environmentName) | Select-Object -unique | Where-Object { $_ -ne "" }
+
+    if ($environments) {
+        OutputDebug "$($environments.Count) Environment(s) defined: $($environments -join ', ')"
+        foreach ($environmentName in $environments) {
+            $envName = $environmentName.Split(' ')[0]
+            # Default deployment settings
+            $deploymentSettings = @{
+                "EnvironmentType" = "SaaS"
+                "EnvironmentName" = $envName
+                "Branches" = @()
+                "Projects" = @('*')
+                "DependencyInstallMode" = "install"  # ignore, install, upgrade or forceUpgrade
+                "includeTestAppsInSandboxEnvironment" = $false
+                "excludeAppIds" = @()
+                "Scope" = $null
+                "SyncMode" = $null
+                "buildMode" = $null
+                "continuousDeployment" = $null
+                "runs-on" = $settings."runs-on"
+                "shell" = $settings."shell"
+                "companyId" = ''
+                "ppEnvironmentUrl" = ''
+            }
+            $settingsName = "DeployTo$envName"
+            if ($settings.Contains($settingsName)) {
+                # If a DeployTo<environmentName> setting exists - use values from this (over the defaults)
+                Write-Host "Using custom settings for environment $environmentName"
+                $deployTo = $settings."$settingsName"
+                $keys = @($deployTo.Keys)
+                foreach($key in $keys) {
+                    if ($deploymentSettings.Contains($key)) {
+                        if ($null -ne $deploymentSettings."$key" -and $null -ne $deployTo."$key" -and $deploymentSettings."$key".GetType().Name -ne $deployTo."$key".GetType().Name) {
+                            if ($key -eq "runs-on" -and $deployTo."$key" -is [Object[]]) {
+                                # Support setting runs-on as an array in settings to not break old settings
+                                # See https://github.com/microsoft/AL-Go/issues/1182
+                                $deployTo."$key" = $deployTo."$key" -join ','
+                            }
+                            else {
+                                OutputWarning -message "The property $key in $settingsName is expected to be of type $($deploymentSettings."$key".GetType().Name)"
+                            }
+                        }
+                        $deploymentSettings."$key" = $deployTo."$key"
+                    }
+                }
+                if ($deploymentSettings."shell" -ne 'pwsh' -and $deploymentSettings."shell" -ne 'powershell') {
+                    throw "The shell setting in $settingsName must be either 'pwsh' or 'powershell'"
+                }
+                if ($deploymentSettings."runs-on" -like "*ubuntu-*" -and $deploymentSettings."shell" -eq "powershell") {
+                    Write-Host "Switching deployment shell to pwsh for ubuntu"
+                    $deploymentSettings."shell" = "pwsh"
+                }
+            }
+            OutputDebug -message "Deployment settings for environment $($envName): $($deploymentSettings | ConvertTo-Json -Depth 5 -Compress)"
+            $settings."$settingsName" = $deploymentSettings
+        }
+    } else {
+        OutputDebug "No environments defined"
+    }
+
     $settings | ValidateSettings
 
     $settings
@@ -608,5 +677,21 @@ function SanitizeWorkflowName {
     return $workflowName.Trim().Split([System.IO.Path]::getInvalidFileNameChars()) -join ""
 }
 
+function GetGitHubEnvironments() {
+    OutputDebugFunctionCall
+    $headers = GetHeaders -token $env:GITHUB_TOKEN
+    $url = "$($ENV:GITHUB_API_URL)/repos/$($ENV:GITHUB_REPOSITORY)/environments"
+    OutputDebug "Url: $url"
+    try {
+        Write-Host "Requesting environments from GitHub"
+        $ghEnvironments = @(((InvokeWebRequest -Headers $headers -Uri $url).Content | ConvertFrom-Json).environments)
+    }
+    catch {
+        $ghEnvironments = @()
+        Write-Host "Failed to get environments from GitHub API - Environments are not supported in this repository"
+    }
+    $ghEnvironments
+}
+
 Export-ModuleMember -Function ReadSettings
 Export-ModuleMember -Variable ALGoFolderName, ALGoSettingsFile, RepoSettingsFile, CustomTemplateRepoSettingsFile, CustomTemplateProjectSettingsFile

Actions/BuildReferenceDocumentation/BuildReferenceDocumentation.ps1

@@ -17,13 +17,33 @@ $excludeProjects = $settings.alDoc.excludeProjects
 $maxReleases = $settings.alDoc.maxReleases
 $artifactsFolder = Join-Path $ENV:GITHUB_WORKSPACE ".artifacts"
 $artifactsFolderCreated = $false
+$buildModePrefixes = @()
+if ($settings.PSObject.Properties.Name -contains "buildModes") {
+    $buildModes = $settings.buildModes
+    foreach($buildMode in $buildModes) {
+        if ($buildMode -eq 'default') {
+            $buildMode = ''
+        }
+        if (-not ($buildModePrefixes -contains $buildMode)) {
+            $buildModePrefixes += $buildMode
+        }
+    }
+}
+if ($buildModePrefixes.Count -eq 0) {
+    $buildModePrefixes += ''
+}
+Write-Host $buildModePrefixes
 if (!(Test-Path $artifactsFolder)) {
     New-Item $artifactsFolder -ItemType Directory | Out-Null
     $artifactsFolderCreated = $true
 }
 if ($artifacts -ne ".artifacts") {
     Write-Host "::group::Downloading artifacts"
-    $allArtifacts = @(GetArtifacts -token $token -api_url $ENV:GITHUB_API_URL -repository $ENV:GITHUB_REPOSITORY -mask "Apps" -projects '*' -Version $artifacts -branch $ENV:GITHUB_REF_NAME)
+    $allArtifacts = @()
+    $buildModePrefixes | ForEach-Object {
+        $allArtifacts += @(GetArtifacts -token $token -api_url $ENV:GITHUB_API_URL -repository $ENV:GITHUB_REPOSITORY -mask "$($_)Apps" -projects '*' -Version $artifacts -branch $ENV:GITHUB_REF_NAME)
+    }
+    # $allArtifacts = @(GetArtifacts -token $token -api_url $ENV:GITHUB_API_URL -repository $ENV:GITHUB_REPOSITORY -mask "Apps" -projects '*' -Version $artifacts -branch $ENV:GITHUB_REF_NAME)
     if ($allArtifacts) {
         $allArtifacts | ForEach-Object {
             $filename = DownloadArtifact -token $token -artifact $_ -path $artifactsFolder

Actions/CheckForUpdates/CheckForUpdates.HelperFunctions.ps1

@@ -244,7 +244,7 @@ function ModifyBuildWorkflows {
     # Modify Deliver and Deploy steps depending on build jobs
     if ($deploy) {
         $deploy.Replace('needs:', "needs: [ $($needs -join ', ') ]")
-        $deploy.Replace('if:', "if: (!cancelled())$ifpart && needs.Initialization.outputs.environmentCount > 0")
+        $deploy.Replace('if:', "if: (!cancelled())$ifpart && fromJson(needs.Initialization.outputs.deploymentEnvironmentsJson).environmentCount > 0")
         $yaml.Replace('jobs:/Deploy:/', $deploy.content)
         $postProcessNeeds += @('Deploy')
     }

Actions/Deploy/Deploy.ps1

@@ -8,8 +8,6 @@ Param(
     [Parameter(HelpMessage = "Type of deployment (CD or Publish)", Mandatory = $false)]
     [ValidateSet('CD','Publish')]
     [string] $type = "CD",
-    [Parameter(HelpMessage = "The settings for all Deployment Environments", Mandatory = $true)]
-    [string] $deploymentEnvironmentsJson,
     [Parameter(HelpMessage = "Artifacts version. Used to check if this is a deployment from a PR", Mandatory = $false)]
     [string] $artifactsVersion = ''
 )
@@ -18,41 +16,17 @@ Import-Module (Join-Path -Path $PSScriptRoot "Deploy.psm1")
 . (Join-Path -Path $PSScriptRoot -ChildPath "..\AL-Go-Helper.ps1" -Resolve)
 DownloadAndImportBcContainerHelper
 
-$deploymentEnvironments = $deploymentEnvironmentsJson | ConvertFrom-Json | ConvertTo-HashTable -recurse
-$deploymentSettings = $deploymentEnvironments."$environmentName"
-
 $envName = $environmentName.Split(' ')[0]
+
 $secrets = $env:Secrets | ConvertFrom-Json
 $settings = $env:Settings | ConvertFrom-Json | ConvertTo-HashTable -recurse
 
-# Check DeployTo<environmentName> setting (it could have been added in the environment-specific settings)
-$settingsName = "DeployTo$envName"
-if ($settings.ContainsKey($settingsName)) {
-    # If a DeployTo<environmentName> setting exists - use values from this (over the defaults)
-    Write-Host "Setting $settingsName"
-    $deployTo = $settings."$settingsName"
-    $keys = @($deployTo.Keys)
-    foreach($key in $keys) {
-        if ($deploymentSettings.ContainsKey($key)) {
-            if ($null -ne $deploymentSettings."$key" -and $null -ne $deployTo."$key" -and $deploymentSettings."$key".GetType().Name -ne $deployTo."$key".GetType().Name) {
-                if ($key -eq "runs-on" -and $deployTo."$key" -is [Object[]]) {
-                    # Support setting runs-on as an array in settings to not break old settings
-                    # See https://github.com/microsoft/AL-Go/issues/1182
-                    $deployTo."$key" = $deployTo."$key" -join ','
-                }
-                else {
-                    Write-Host "::WARNING::The property $key in $settingsName is expected to be of type $($deploymentSettings."$key".GetType().Name)"
-                }
-            }
-            Write-Host "Property $key = $($deployTo."$key")"
-            $deploymentSettings."$key" = $deployTo."$key"
-        }
-        else {
-            $deploymentSettings += @{
-                "$key" = $deployTo."$key"
-            }
-        }
-    }
+$settingsName = "deployTo$($envName)"
+if($settings.Keys -contains $settingsName) {
+    $deploymentSettings = ($settings."$settingsName") | ConvertTo-HashTable -recurse
+    OutputDebug -message "Using deployment settings: $($deploymentSettings | ConvertTo-Json -Depth 10)"
+} else {
+    OutputError -message "No deployment settings found for environment $envName"
 }
 
 $authContext = $null

Actions/Deploy/README.md

@@ -20,7 +20,6 @@ Deploy Apps to online environment
 | environmentName | Yes | Name of environment to deploy to |
 | artifactsFolder | Yes | Path to the downloaded artifacts to deploy | |
 | type | | Type of delivery (CD or Release) | CD |
-| deploymentEnvironmentsJson | Yes | The settings for all Deployment Environments | |
 
 ## OUTPUT
 

Actions/Deploy/action.yaml

@@ -19,9 +19,6 @@ inputs:
     description: Type of deployment (CD or Publish)
     required: false
     default: 'CD'
-  deploymentEnvironmentsJson:
-    description: The settings for all Deployment Environments
-    required: true
   artifactsVersion:
     description: Artifacts version. Used to check if this is a deployment from a PR
     required: false
@@ -41,11 +38,10 @@ runs:
         _environmentName: ${{ inputs.environmentName }}
         _artifactsFolder: ${{ inputs.artifactsFolder }}
         _type: ${{ inputs.type }}
-        _deploymentEnvironmentsJson: ${{ inputs.deploymentEnvironmentsJson }}
         _artifactsVersion: ${{ inputs.artifactsVersion }}
       run: |
         ${{ github.action_path }}/../Invoke-AlGoAction.ps1 -ActionName "Deploy" -Action {
-          ${{ github.action_path }}/Deploy.ps1 -token $ENV:_token -environmentName $ENV:_environmentName -artifactsFolder $ENV:_artifactsFolder -type $ENV:_type -deploymentEnvironmentsJson $ENV:_deploymentEnvironmentsJson -artifactsVersion $ENV:_artifactsVersion
+          ${{ github.action_path }}/Deploy.ps1 -token $ENV:_token -environmentName $ENV:_environmentName -artifactsFolder $ENV:_artifactsFolder -type $ENV:_type -artifactsVersion $ENV:_artifactsVersion
         }
 branding:
   icon: terminal

Actions/DeployPowerPlatform/README.md

@@ -19,7 +19,6 @@ Deploy the Power Platform solution from the artifacts folder
 | environmentName | Yes | Name of environment to deploy to |
 | artifactsFolder | | Path to the downloaded artifacts to deploy (when deploying from a build) | |
 | solutionFolder | | Path to the unpacked solutions to deploy (when deploying from branch) | |
-| deploymentEnvironmentsJson | Yes | The settings for all Deployment Environments | |
 
 Either artifactsFolder or solutionFolder needs to be specified
 

Actions/DeployPowerPlatform/action.yaml

@@ -16,9 +16,6 @@ inputs:
     description: Path to the unpacked solution to deploy (when deploying from branch)
     required: false
     default: ''
-  deploymentEnvironmentsJson:
-    description: The settings for all Deployment Environments
-    required: true
 runs:
   using: composite
   steps:
@@ -42,12 +39,16 @@ runs:
         ref: ${{ env.actionsRef }}
         path: ${{ env.actionsPath }}
 
+    - name: Read settings
+      uses: ./_AL-Go/Actions/ReadSettings@main
+      with:
+        shell: ${{ matrix.shell }}
+
     - name: Parse DeployToSettings and AuthContext
       id: ReadPowerPlatformSettings
       uses: ./_AL-Go/Actions/ReadPowerPlatformSettings
       with:
         shell: ${{ inputs.shell }}
-        deploymentEnvironmentsJson: ${{ inputs.deploymentEnvironmentsJson }}
         environmentName: ${{ inputs.environmentName }}
 
     - name: Determine Power Platform solution location