Remove thisbuild artifacts and support preprocessor symbols

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",
@@ -730,6 +731,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

@@ -118,7 +118,8 @@
         $probingPathsJson,
         [string] $api_url = $ENV:GITHUB_API_URL,
         [string] $saveToPath = (Join-Path $ENV:GITHUB_WORKSPACE ".dependencies"),
-        [string[]] $masks = @('Apps','Dependencies','TestApps')
+        [string[]] $masks = @('Apps','Dependencies','TestApps'),
+        [string] $artifactsNameSuffix = ''
     )
 
     if (!(Test-Path $saveToPath)) {
@@ -141,9 +142,10 @@
             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

@@ -370,18 +370,9 @@ try {
 
     switch($buildMode){
         'Clean' {
-            $preprocessorsymbols = $settings.cleanModePreprocessorSymbols
-
-            if (!$preprocessorsymbols) {
+            if (-not $settings.ContainsKey('cleanModePreprocessorSymbols')) {
                 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"] = @()
-            }
-
-            Write-Host "Adding Preprocessor symbols: $preprocessorsymbols"
-            $runAlPipelineParams["preprocessorsymbols"] += $preprocessorsymbols
         }
         'Translated' {
             if ($runAlPipelineParams.Keys -notcontains 'features') {
@@ -391,6 +382,17 @@ try {
         }
     }
 
+    if ($runAlPipelineParams.Keys -notcontains 'preprocessorsymbols') {
+        $runAlPipelineParams["preprocessorsymbols"] = @()
+    }
+    foreach($preprocessorSymbolsSettingsName in @("preprocessorSymbols", "$($buildMode)ModePreprocessorSymbols")) {
+        if ($settings.ContainsKey($preprocessorSymbolsSettingsName)) {
+            $preprocessorsymbols = $settings."$preprocessorSymbolsSettingsName"
+            Write-Host "Adding Preprocessor symbols from setting $preprocessorSymbolsSettingsName : $($preprocessorsymbols -join ',')"
+            $runAlPipelineParams["preprocessorsymbols"] += $preprocessorsymbols
+        }
+    }
+
     Write-Host "Invoke Run-AlPipeline with buildmode $buildMode"
     Run-AlPipeline @runAlPipelineParams `
         -accept_insiderEula `

Scenarios/settings.md

@@ -156,6 +156,7 @@ to your [project settings file](#where-are-the-settings-located) will ensure tha
 
 - **repositories** settings will be applied to repositories matching the patterns
 - **projects** settings will be applied to projects matching the patterns
+- **buildModes** settings will be applied when building with these buildModes
 - **branches** settings will be applied to branches matching the patterns
 - **workflows** settings will be applied to workflows matching the patterns
 - **users** settings will be applied for users matching the patterns

Templates/AppSource App/.github/workflows/CICD.yaml

@@ -43,6 +43,8 @@ jobs:
       buildOrderJson: ${{ steps.determineProjectsToBuild.outputs.BuildOrderJson }}
       powerPlatformSolutionFolder: ${{ steps.DeterminePowerPlatformSolutionFolder.outputs.powerPlatformSolutionFolder }}
       workflowDepth: ${{ steps.DetermineWorkflowDepth.outputs.WorkflowDepth }}
+      artifactsRetentionDays: ${{ steps.DetermineWorkflowDepth.outputs.ArtifactsRetentionDays }}
+
     steps:
       - name: Dump Workflow Information
         uses: microsoft/AL-Go-Actions/DumpWorkflowInfo@main
@@ -88,6 +90,7 @@ jobs:
         id: DetermineWorkflowDepth
         run: |
           Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "WorkflowDepth=$($env:workflowDepth)"
+          Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "ArtifactsRetentionDays=90"
 
       - name: Determine Projects To Build
         id: determineProjectsToBuild
@@ -176,8 +179,7 @@ jobs:
       buildMode: ${{ matrix.buildMode }}
       projectDependenciesJson: ${{ needs.Initialization.outputs.projectDependenciesJson }}
       secrets: 'licenseFileUrl,codeSignCertificateUrl,*codeSignCertificatePassword,keyVaultCertificateUrl,*keyVaultCertificatePassword,keyVaultClientId,gitHubPackagesContext,applicationInsightsConnectionString'
-      publishThisBuildArtifacts: ${{ needs.Initialization.outputs.workflowDepth > 1 }}
-      publishArtifacts: ${{ github.ref_name == 'main' || startswith(github.ref_name, 'release/') || startswith(github.ref_name, 'releases/') || needs.Initialization.outputs.deliveryTargetsJson != '[]' || needs.Initialization.outputs.environmentCount > 0 }}
+      artifactsRetentionDays: ${{ fromJson(needs.Initialization.outputs.artifactsRetentionDays) }}
       signArtifacts: true
       useArtifactCache: true
 

Templates/AppSource App/.github/workflows/Current.yaml

@@ -26,6 +26,7 @@ jobs:
       projectDependenciesJson: ${{ steps.determineProjectsToBuild.outputs.ProjectDependenciesJson }}
       buildOrderJson: ${{ steps.determineProjectsToBuild.outputs.BuildOrderJson }}
       workflowDepth: ${{ steps.DetermineWorkflowDepth.outputs.WorkflowDepth }}
+      artifactsRetentionDays: ${{ steps.DetermineWorkflowDepth.outputs.ArtifactsRetentionDays }}
       telemetryScopeJson: ${{ steps.init.outputs.telemetryScopeJson }}
     steps:
       - name: Dump Workflow Information
@@ -72,6 +73,7 @@ jobs:
         id: DetermineWorkflowDepth
         run: |
           Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "WorkflowDepth=$($env:workflowDepth)"
+          Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "ArtifactsRetentionDays=90"
 
       - name: Determine Projects To Build
         id: determineProjectsToBuild
@@ -98,7 +100,7 @@ jobs:
       buildMode: ${{ matrix.buildMode }}
       projectDependenciesJson: ${{ needs.Initialization.outputs.projectDependenciesJson }}
       secrets: 'licenseFileUrl,codeSignCertificateUrl,*codeSignCertificatePassword,keyVaultCertificateUrl,*keyVaultCertificatePassword,keyVaultClientId,gitHubPackagesContext,applicationInsightsConnectionString'
-      publishThisBuildArtifacts: ${{ needs.Initialization.outputs.workflowDepth > 1 }}
+      artifactsRetentionDays: ${{ fromJson(needs.Initialization.outputs.artifactsRetentionDays) }}
       artifactsNameSuffix: 'Current'
 
   PostProcess:

Templates/AppSource App/.github/workflows/NextMajor.yaml

@@ -26,6 +26,7 @@ jobs:
       projectDependenciesJson: ${{ steps.determineProjectsToBuild.outputs.ProjectDependenciesJson }}
       buildOrderJson: ${{ steps.determineProjectsToBuild.outputs.BuildOrderJson }}
       workflowDepth: ${{ steps.DetermineWorkflowDepth.outputs.WorkflowDepth }}
+      artifactsRetentionDays: ${{ steps.DetermineWorkflowDepth.outputs.ArtifactsRetentionDays }}
       telemetryScopeJson: ${{ steps.init.outputs.telemetryScopeJson }}
     steps:
       - name: Dump Workflow Information
@@ -72,6 +73,7 @@ jobs:
         id: DetermineWorkflowDepth
         run: |
           Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "WorkflowDepth=$($env:workflowDepth)"
+          Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "ArtifactsRetentionDays=90"
 
       - name: Determine Projects To Build
         id: determineProjectsToBuild
@@ -98,7 +100,7 @@ jobs:
       buildMode: ${{ matrix.buildMode }}
       projectDependenciesJson: ${{ needs.Initialization.outputs.projectDependenciesJson }}
       secrets: 'licenseFileUrl,codeSignCertificateUrl,*codeSignCertificatePassword,keyVaultCertificateUrl,*keyVaultCertificatePassword,keyVaultClientId,gitHubPackagesContext,applicationInsightsConnectionString'
-      publishThisBuildArtifacts: ${{ needs.Initialization.outputs.workflowDepth > 1 }}
+      artifactsRetentionDays: ${{ fromJson(needs.Initialization.outputs.artifactsRetentionDays) }}
       artifactsNameSuffix: 'NextMajor'
 
   PostProcess:

Templates/AppSource App/.github/workflows/NextMinor.yaml

@@ -26,6 +26,7 @@ jobs:
       projectDependenciesJson: ${{ steps.determineProjectsToBuild.outputs.ProjectDependenciesJson }}
       buildOrderJson: ${{ steps.determineProjectsToBuild.outputs.BuildOrderJson }}
       workflowDepth: ${{ steps.DetermineWorkflowDepth.outputs.WorkflowDepth }}
+      artifactsRetentionDays: ${{ steps.DetermineWorkflowDepth.outputs.ArtifactsRetentionDays }}
       telemetryScopeJson: ${{ steps.init.outputs.telemetryScopeJson }}
     steps:
       - name: Dump Workflow Information
@@ -72,6 +73,7 @@ jobs:
         id: DetermineWorkflowDepth
         run: |
           Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "WorkflowDepth=$($env:workflowDepth)"
+          Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "ArtifactsRetentionDays=90"
 
       - name: Determine Projects To Build
         id: determineProjectsToBuild
@@ -98,7 +100,7 @@ jobs:
       buildMode: ${{ matrix.buildMode }}
       projectDependenciesJson: ${{ needs.Initialization.outputs.projectDependenciesJson }}
       secrets: 'licenseFileUrl,codeSignCertificateUrl,*codeSignCertificatePassword,keyVaultCertificateUrl,*keyVaultCertificatePassword,keyVaultClientId,gitHubPackagesContext,applicationInsightsConnectionString'
-      publishThisBuildArtifacts: ${{ needs.Initialization.outputs.workflowDepth > 1 }}
+      artifactsRetentionDays: ${{ fromJson(needs.Initialization.outputs.artifactsRetentionDays) }}
       artifactsNameSuffix: 'NextMinor'
 
   PostProcess:

Templates/AppSource App/.github/workflows/PullRequestHandler.yaml

@@ -40,6 +40,7 @@ jobs:
       buildOrderJson: ${{ steps.determineProjectsToBuild.outputs.BuildOrderJson }}
       baselineWorkflowRunId: ${{ steps.determineProjectsToBuild.outputs.BaselineWorkflowRunId }}
       workflowDepth: ${{ steps.DetermineWorkflowDepth.outputs.WorkflowDepth }}
+      artifactsRetentionDays: ${{ steps.DetermineWorkflowDepth.outputs.ArtifactsRetentionDays }}
       telemetryScopeJson: ${{ steps.init.outputs.telemetryScopeJson }}
     steps:
       - name: Dump Workflow Information
@@ -69,6 +70,7 @@ jobs:
         id: DetermineWorkflowDepth
         run: |
           Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "WorkflowDepth=$($env:workflowDepth)"
+          Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "ArtifactsRetentionDays=90"
 
       - name: Determine Projects To Build
         id: determineProjectsToBuild
@@ -97,7 +99,7 @@ jobs:
       projectDependenciesJson: ${{ needs.Initialization.outputs.projectDependenciesJson }}
       baselineWorkflowRunId: ${{ needs.Initialization.outputs.baselineWorkflowRunId }}
       secrets: 'licenseFileUrl,keyVaultCertificateUrl,*keyVaultCertificatePassword,keyVaultClientId,gitHubPackagesContext,applicationInsightsConnectionString'
-      publishThisBuildArtifacts: ${{ needs.Initialization.outputs.workflowDepth > 1 }}
+      artifactsRetentionDays: ${{ fromJson(needs.Initialization.outputs.artifactsRetentionDays) }}
       artifactsNameSuffix: 'PR${{ github.event.number }}'
 
   StatusCheck:

Templates/AppSource App/.github/workflows/_BuildALGoProject.yaml

@@ -46,14 +46,10 @@ on:
         required: false
         default: ''
         type: string
-      publishThisBuildArtifacts:
-        description: Flag indicating whether this build artifacts should be published
-        type: boolean
-        default: false
-      publishArtifacts:
-        description: Flag indicating whether the artifacts should be published
-        type: boolean
-        default: false
+      artifactsRetentionDays:
+        description: Number of days to keep the artifacts
+        type: number
+        default: 0
       artifactsNameSuffix:
         description: Suffix to add to the artifacts names
         required: false
@@ -97,6 +93,7 @@ jobs:
         with:
           shell: ${{ inputs.shell }}
           project: ${{ inputs.project }}
+          buildMode: ${{ inputs.buildMode }}
           get: useCompilerFolder,keyVaultCodesignCertificateName,doNotSignApps,doNotRunTests,artifact,generateDependencyArtifact,trustedSigning,useGitSubmodules
 
       - name: Read secrets
@@ -175,56 +172,32 @@ jobs:
           buildMode: ${{ inputs.buildMode }}
           suffix: ${{ inputs.artifactsNameSuffix }}
 
-      - name: Upload thisbuild artifacts - apps
-        if: inputs.publishThisBuildArtifacts
-        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
-        with:
-          name: ${{ steps.calculateArtifactsNames.outputs.ThisBuildAppsArtifactsName }}
-          path: '${{ inputs.project }}/.buildartifacts/Apps/'
-          if-no-files-found: ignore
-          retention-days: 1
-
-      - name: Upload thisbuild artifacts - dependencies
-        if: inputs.publishThisBuildArtifacts
-        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
-        with:
-          name: ${{ steps.calculateArtifactsNames.outputs.ThisBuildDependenciesArtifactsName }}
-          path: '${{ inputs.project }}/.buildartifacts/Dependencies/'
-          if-no-files-found: ignore
-          retention-days: 1
-
-      - name: Upload thisbuild artifacts - test apps
-        if: inputs.publishThisBuildArtifacts
-        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
-        with:
-          name: ${{ steps.calculateArtifactsNames.outputs.ThisBuildTestAppsArtifactsName }}
-          path: '${{ inputs.project }}/.buildartifacts/TestApps/'
-          if-no-files-found: ignore
-          retention-days: 1
-
       - name: Publish artifacts - apps
         uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
-        if: inputs.publishArtifacts
+        if: inputs.artifactsRetentionDays > 0
         with:
           name: ${{ steps.calculateArtifactsNames.outputs.AppsArtifactsName }}
           path: '${{ inputs.project }}/.buildartifacts/Apps/'
           if-no-files-found: ignore
+          retention-days: ${{ inputs.artifactsRetentionDays }}
 
       - name: Publish artifacts - dependencies
         uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
-        if: inputs.publishArtifacts && env.generateDependencyArtifact == 'True'
+        if: inputs.artifactsRetentionDays > 0 && env.generateDependencyArtifact == 'True'
         with:
           name: ${{ steps.calculateArtifactsNames.outputs.DependenciesArtifactsName }}
           path: '${{ inputs.project }}/.buildartifacts/Dependencies/'
           if-no-files-found: ignore
+          retention-days: ${{ inputs.artifactsRetentionDays }}
 
       - name: Publish artifacts - test apps
         uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
-        if: inputs.publishArtifacts
+        if: inputs.artifactsRetentionDays > 0
         with:
           name: ${{ steps.calculateArtifactsNames.outputs.TestAppsArtifactsName }}
           path: '${{ inputs.project }}/.buildartifacts/TestApps/'
           if-no-files-found: ignore
+          retention-days: ${{ inputs.artifactsRetentionDays }}
 
       - name: Publish artifacts - build output
         uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0