Remove thisbuild artifacts and support preprocessor symbols (#1374)

This is a proposed fix for
https://github.com/orgs/microsoft/projects/521/views/1?pane=issue&itemId=91449371
and will greatly improve the capabilities of build modes (as requested
by partners during our roundtable at Directions EMEA).
 
### New Repository Settings

-
[`shortLivedArtifactsRetentionDays`](https://aka.ms/algosettings#shortLivedArtifactsRetentionDays)
determines the number of days to keep short lived build artifacts (f.ex
build artifacts from pull request builds, next minor or next major
builds). 1 is default. 0 means use GitHub default.
-
[`preProcessorSymbols`](https://aka.ms/algosettings#preProcessorSymbols)
is a list of preprocessor symbols to use when building the apps. This
setting can be specified in workflow specific settings files or in
conditional settings.

### Change in published artifacts

When using `useProjectDependencies` in a multi-project repository, AL-Go
for GitHub used to generate short lived build artifacts called
`thisBuild-<projectnaame>-<type>-...`. This is no longer the case.
Instead, normal build artifacts will be published and used by depending
projects. The retention period for the artifacts generated are
controlled by a settings called
[`shortLivedArtifactsRetentionDays`](https://aka.ms/algosettings#shortLivedArtifactsRetentionDays).

### Preprocessor symbols

It is now possible to define preprocessor symbols, which will be used
when building your apps using the
[`preProcessorSymbols`](https://aka.ms/algosettings#preProcessorSymbols)
setting. This setting can be specified in workflow specific settings
file or it can be used in conditional settings.

---------

Co-authored-by: freddydk <[email protected]>

Author: Freddy Kristiansen

Actions/AL-Go-Helper.ps1

@@ -522,6 +522,7 @@ function ReadSettings {
         [string] $baseFolder = "$ENV:GITHUB_WORKSPACE",
         [string] $repoName = "$ENV:GITHUB_REPOSITORY",
         [string] $project = '.',
+        [string] $buildMode = "Default",
         [string] $workflowName = "$ENV:GITHUB_WORKFLOW",
         [string] $userName = "$ENV:GITHUB_ACTOR",
         [string] $branchName = "$ENV:GITHUB_REF_NAME",
@@ -686,6 +687,7 @@ function ReadSettings {
         }
         "useGitSubmodules"                              = "false"
         "gitSubmodulesTokenSecretName"                  = "gitSubmodulesToken"
+        "shortLivedArtifactsRetentionDays"              = 1  # 0 means use GitHub default
     }
 
     # Read settings from files and merge them into the settings object
@@ -730,6 +732,10 @@ function ReadSettings {
                     if ("$conditionalSetting" -ne "") {
                         $conditionMet = $true
                         $conditions = @()
+                        if ($conditionalSetting.PSObject.Properties.Name -eq "buildModes") {
+                            $conditionMet = $conditionMet -and ($conditionalSetting.buildModes | Where-Object { $buildMode -like $_ })
+                            $conditions += @("buildMode: $buildMode")
+                        }
                         if ($conditionalSetting.PSObject.Properties.Name -eq "branches") {
                             $conditionMet = $conditionMet -and ($conditionalSetting.branches | Where-Object { $branchName -like $_ })
                             $conditions += @("branchName: $branchName")

Actions/CalculateArtifactNames/CalculateArtifactNames.ps1

@@ -54,10 +54,3 @@ else {
     $value = "$($projectName)-$($branchName)-$buildMode$_-$suffix"
     Set-OutputVariable -name $name -value $value
 }
-
-# Set this build artifacts name
-'Apps', 'Dependencies', 'TestApps' | ForEach-Object {
-    $name = "ThisBuild$($_)ArtifactsName"
-    $value = "thisbuild-$($projectName)-$($buildMode)$($_)"
-    Set-OutputVariable -name $name -value $value
-}

Actions/CalculateArtifactNames/README.md

@@ -29,9 +29,6 @@ none
 
 | Name | Description |
 | :-- | :-- |
-| ThisBuildAppsArtifactsName | Artifact name for apps being built in the current workflow run |
-| ThisBuildDependenciesArtifactsName | Artifact name for dependencies of apps being built in the current workflow run |
-| ThisBuildTestAppsArtifactsName | Artifact name for test apps being built in the current workflow run |
 | AppsArtifactsName | Artifacts name for Apps |
 | PowerPlatformSolutionArtifactsName | Artifacts name for PowerPlatform Solution |
 | DependenciesArtifactsName | Artifacts name for Dependencies |

Actions/CalculateArtifactNames/action.yaml

@@ -16,15 +16,6 @@ inputs:
     required: false
     default: ''
 outputs:
-  ThisBuildAppsArtifactsName:
-    description: Artifact name for apps being built in the current workflow run
-    value: ${{ steps.calculateartifactnames.outputs.ThisBuildAppsArtifactsName }}
-  ThisBuildDependenciesArtifactsName:
-    description: Artifact name for dependencies of apps being built in the current workflow run
-    value: ${{ steps.calculateartifactnames.outputs.ThisBuildDependenciesArtifactsName }}
-  ThisBuildTestAppsArtifactsName:
-    description: Artifact name for test apps being built in the current workflow run
-    value: ${{ steps.calculateartifactnames.outputs.ThisBuildTestAppsArtifactsName }}
   AppsArtifactsName:
     description: Artifacts name for Apps
     value: ${{ steps.calculateartifactnames.outputs.AppsArtifactsName }}

Actions/Github-Helper.psm1

@@ -141,9 +141,10 @@ function GetDependencies {
             if ($dependency.release_status -eq "thisBuild") {
                 $missingProjects = @()
                 foreach($project in $projects.Split(',')) {
+                    $branchName = $dependency.branch.Replace('\', '_').Replace('/', '_')
                     $project = $project.Replace('\','_').Replace('/','_') # sanitize project name
 
-                    $downloadName = Join-Path $saveToPath "thisbuild-$project-$($mask)"
+                    $downloadName = Join-Path $saveToPath "$project-$branchName-$mask-*"
 
                     if (Test-Path $downloadName -PathType Container) {
                         $folder = Get-Item $downloadName

Actions/ReadSettings/README.md

@@ -14,6 +14,7 @@ none
 | :-- | :-: | :-- | :-- |
 | shell | | The shell (powershell or pwsh) in which the PowerShell script in this action should run | powershell |
 | project | | Project name if the repository is setup for multiple projects | . |
+| buildMode | | Build mode. Only set when called from \_BuildALGoProject | Default |
 | get | | Specifies which properties to get from the settings file, default is all | |
 
 ## OUTPUT

Actions/ReadSettings/ReadSettings.ps1

@@ -1,13 +1,15 @@
 Param(
     [Parameter(HelpMessage = "Project folder", Mandatory = $false)]
     [string] $project = ".",
+    [Parameter(HelpMessage = "Build mode", Mandatory = $false)]
+    [string] $buildMode = "Default",
     [Parameter(HelpMessage = "Specifies which properties to get from the settings file, default is all", Mandatory = $false)]
     [string] $get = ""
 )
 
 . (Join-Path -Path $PSScriptRoot -ChildPath "..\AL-Go-Helper.ps1" -Resolve)
 
-$settings = ReadSettings -project $project
+$settings = ReadSettings -project $project -buildMode $buildMode
 if ($get) {
     $getSettings = $get.Split(',').Trim()
 }

Actions/ReadSettings/action.yaml

@@ -9,6 +9,10 @@ inputs:
     description: Project folder
     required: false
     default: '.'
+  buildMode:
+    description: Build mode
+    required: false
+    default: 'Default'
   get:
     description: Specifies which properties to get from the settings file, default is all
     required: false
@@ -28,10 +32,11 @@ runs:
       id: readsettings
       env:
         _project: ${{ inputs.project }}
+        _buildMode: ${{ inputs.buildMode }}
         _get: ${{ inputs.get }}
       run: |
         ${{ github.action_path }}/../Invoke-AlGoAction.ps1 -ActionName "ReadSettings" -Action {
-          ${{ github.action_path }}/ReadSettings.ps1 -project $ENV:_project -get $ENV:_get
+          ${{ github.action_path }}/ReadSettings.ps1 -project $ENV:_project -buildMode $ENV:_buildMode -get $ENV:_get
         }
 branding:
   icon: terminal

Actions/RunPipeline/RunPipeline.ps1

@@ -368,27 +368,29 @@ try {
         if ($settings."$_") { $runAlPipelineParams += @{ "$_" = $true } }
     }
 
-    switch($buildMode){
-        'Clean' {
-            $preprocessorsymbols = $settings.cleanModePreprocessorSymbols
+    if ($buildMode -eq 'Translated') {
+        if ($runAlPipelineParams.Keys -notcontains 'features') {
+            $runAlPipelineParams["features"] = @()
+        }
+        Write-Host "Adding translationfile feature"
+        $runAlPipelineParams["features"] += "translationfile"
+    }
 
-            if (!$preprocessorsymbols) {
-                throw "No cleanModePreprocessorSymbols defined in settings.json for this project. Please add the preprocessor symbols to use when building in clean mode or disable CLEAN mode."
-            }
+    if ($runAlPipelineParams.Keys -notcontains 'preprocessorsymbols') {
+        $runAlPipelineParams["preprocessorsymbols"] = @()
+    }
 
-            if ($runAlPipelineParams.Keys -notcontains 'preprocessorsymbols') {
-                $runAlPipelineParams["preprocessorsymbols"] = @()
-            }
+    # REMOVE AFTER April 1st 2025 --->
+    if ($settings.ContainsKey('cleanModePreprocessorSymbols')) {
+        Write-Host "Adding Preprocessor symbols : $($settings.cleanModePreprocessorSymbols -join ',')"
+        $runAlPipelineParams["preprocessorsymbols"] += $settings.cleanModePreprocessorSymbols
+        Write-Warning -message "cleanModePreprocessorSymbols is deprecated. See https://aka.ms/ALGoDeprecations#cleanModePreprocessorSymbols for more information."
+    }
+    # <--- REMOVE AFTER April 1st 2025
 
-            Write-Host "Adding Preprocessor symbols: $preprocessorsymbols"
-            $runAlPipelineParams["preprocessorsymbols"] += $preprocessorsymbols
-        }
-        'Translated' {
-            if ($runAlPipelineParams.Keys -notcontains 'features') {
-                $runAlPipelineParams["features"] = @()
-            }
-            $runAlPipelineParams["features"] += "translationfile"
-        }
+    if ($settings.ContainsKey('preprocessorSymbols')) {
+        Write-Host "Adding Preprocessor symbols : $($settings.preprocessorSymbols -join ',')"
+        $runAlPipelineParams["preprocessorsymbols"] += $settings.preprocessorSymbols
     }
 
     Write-Host "Invoke Run-AlPipeline with buildmode $buildMode"

DEPRECATIONS.md

@@ -0,0 +1,30 @@
+# Deprecated features in AL-Go for GitHub
+
+This file contains a list of deprecations in AL-Go for GitHub, sorted by the date after which the support will be removed.
+
+## Old AL-Go versions might stop working any time
+
+Microsoft recommends that you always run the latest version of AL-Go for GitHub.
+
+Old versions of AL-Go for GitHub uses old and unsupported versions of GitHub actions, which might be removed or no longer work due to unresolved dependencies no longer being installed on the GitHub runners.
+
+When handling support requests, we will request that you to use the latest version of AL-Go for GitHub and in general, fixes will only be made available in a preview version of AL-Go for GitHub and subsequently in the next version released.
+
+## Changes in effect after April 1st 2025
+
+<a id="cleanModePreprocessorSymbols"></a>
+
+### Setting `cleanModePreprocessorSymbols` will no longer be supported
+
+[preprocessorSymbols](https://aka.ms/algosettings#preprocessorSymbols) are now supported as a global setting and can be applied to buildModes using [Conditional Settings](https://aka.ms/algosettings#conditional-settings). Example:
+
+```
+"conditionalSettings": [
+    {
+        "buildModes": [ "Clean" ],
+        "settings": {
+            "preprocessorSymbols": [ "CLEAN21", "CLEAN22" ]
+        }
+    }
+]
+```