Add support for updating AL-Go files from custom templates

.github/workflows/E2E.yaml

@@ -25,6 +25,11 @@ on:
         description: Run the end to end scenario tests
         type: boolean
         default: true
+      scenariosFilter:
+        description: Filter to run specific scenarios (separated by comma)
+        required: false
+        type: string
+        default: '*'
       runUpgradeTests:
         description: Run the end to end upgrade tests
         type: boolean
@@ -169,6 +174,7 @@ jobs:
         id: Analyze
         env:
           GH_TOKEN: ${{ steps.app-token.outputs.token }}
+          _scenariosFilter: ${{ github.event.inputs.scenariosFilter }}
         run: |
           $errorActionPreference = "Stop"; $ProgressPreference = "SilentlyContinue"; Set-StrictMode -Version 2.0
           $modulePath = Join-Path "." "e2eTests\e2eTestHelper.psm1" -resolve
@@ -222,9 +228,13 @@ jobs:
           Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "releases=$releasesJson"
           Write-Host "releases=$releasesJson"
 
+          $scenariosFilter = "$($env:_scenariosFilter)" -split ',' | ForEach-Object { $_.Trim() } | Where-Object { $_ -ne '' }
+          $allScenarios = @(Get-ChildItem -Path (Join-Path $ENV:GITHUB_WORKSPACE "e2eTests/scenarios/*/runtest.ps1") | ForEach-Object { $_.Directory.Name })
+          $filteredScenarios = $allScenarios | Where-Object { $scenario = $_; $scenariosFilter | ForEach-Object { $scenario -like $_ } }
+
           $scenariosJson = @{
             "matrix" = @{
-              "include" = @(Get-ChildItem -path (Join-Path $ENV:GITHUB_WORKSPACE "e2eTests/scenarios/*/runtest.ps1") | ForEach-Object { @{ "Scenario" = $_.Directory.Name } } )
+              "include" = @($filteredScenarios | ForEach-Object { @{ "Scenario" = $_ } })
             };
             "max-parallel" = $maxParallel
             "fail-fast" = $false

Actions/.Modules/DebugLogHelper.psm1

@@ -214,5 +214,55 @@ function OutputDebug {
     }
 }
 
-Export-ModuleMember -Function OutputColor, OutputDebugFunctionCall, OutputGroupStart, OutputGroupEnd, OutputError, OutputWarning, OutputNotice, MaskValueInLog, OutputDebug
+<#
+    .SYNOPSIS
+        Outputs each item in an array to the console with optional formatting.
+    .DESCRIPTION
+        Outputs each item in an array to the console. An optional formatter script block can be provided to customize the output format of each item.
+        If a message is provided, it is output before the array items. If the array is empty or null, it outputs "- None".
+    .PARAMETER Message
+        An optional message to output before the array items.
+    .PARAMETER Array
+        The array of items to output.
+    .PARAMETER Formatter
+        An optional script block to format each item in the array.
+    .PARAMETER Debug
+        A switch indicating whether to output messages as debug messages.
+#>
+function OutputArray {
+    Param(
+        [string] $Message,
+        [object[]] $Array,
+        [scriptblock] $Formatter = { "- $_" },
+        [switch] $Debug
+    )
+
+    function OutputMessage {
+        Param(
+            [string] $Message,
+            [switch] $Debug
+        )
+
+        if ($Debug) {
+            OutputDebug $Message
+        }
+        else {
+            Write-Host $Message
+        }
+    }
+
+    if($Message) {
+        OutputMessage $Message -Debug:$Debug
+    }
+    if (!$Array) {
+        OutputMessage "- None" -Debug:$Debug
+    }
+    else {
+        $Array | ForEach-Object {
+            OutputMessage "$(& $Formatter $_)" -Debug:$Debug
+        }
+    }
+}
+
+Export-ModuleMember -Function OutputColor, OutputDebugFunctionCall, OutputGroupStart, OutputGroupEnd, OutputError, OutputWarning, OutputNotice, MaskValueInLog, OutputDebug, OutputArray
 Export-ModuleMember -Variable debugLoggingEnabled

Actions/.Modules/ReadSettings.psm1

@@ -1,10 +1,17 @@
 Import-Module (Join-Path -Path $PSScriptRoot "DebugLogHelper.psm1")
 
 $ALGoFolderName = '.AL-Go'
-$ALGoSettingsFile = Join-Path '.AL-Go' 'settings.json'
-$RepoSettingsFile = Join-Path '.github' 'AL-Go-Settings.json'
-$CustomTemplateRepoSettingsFile = Join-Path '.github' 'AL-Go-TemplateRepoSettings.doNotEdit.json'
-$CustomTemplateProjectSettingsFile = Join-Path '.github' 'AL-Go-TemplateProjectSettings.doNotEdit.json'
+$ALGoSettingsFileName = 'settings.json'
+$ALGoSettingsFile = Join-Path '.AL-Go' $ALGoSettingsFileName
+
+$RepoSettingsFileName = 'AL-Go-Settings.json'
+$RepoSettingsFile = Join-Path '.github' $RepoSettingsFileName
+
+$CustomTemplateRepoSettingsFileName = 'AL-Go-TemplateRepoSettings.doNotEdit.json'
+$CustomTemplateRepoSettingsFile = Join-Path '.github' $CustomTemplateRepoSettingsFileName
+
+$CustomTemplateProjectSettingsFileName = 'AL-Go-TemplateProjectSettings.doNotEdit.json'
+$CustomTemplateProjectSettingsFile = Join-Path '.github' $CustomTemplateProjectSettingsFileName
 
 function MergeCustomObjectIntoOrderedDictionary {
     Param(
@@ -242,6 +249,10 @@ function GetDefaultSettings
         "shortLivedArtifactsRetentionDays"              = 1  # 0 means use GitHub default
         "reportSuppressedDiagnostics"                   = $false
         "workflowDefaultInputs"                         = @()
+        "customALGoFiles" = [ordered]@{
+            "filesToInclude"                             = @()
+            "filesToExclude"                            = @()
+        }
     }
 }
 
@@ -610,4 +621,4 @@ function SanitizeWorkflowName {
 }
 
 Export-ModuleMember -Function ReadSettings
-Export-ModuleMember -Variable ALGoFolderName, ALGoSettingsFile, RepoSettingsFile, CustomTemplateRepoSettingsFile, CustomTemplateProjectSettingsFile
+Export-ModuleMember -Variable ALGoFolderName, ALGoSettingsFile, RepoSettingsFile, CustomTemplateRepoSettingsFile, CustomTemplateProjectSettingsFile, RepoSettingsFileName, ALGoSettingsFileName, CustomTemplateRepoSettingsFileName, CustomTemplateProjectSettingsFileName

Actions/.Modules/settings.schema.json

@@ -694,6 +694,52 @@
             "type": "boolean",
             "description": "Report suppressed diagnostics. See https://aka.ms/ALGoSettings#reportsuppresseddiagnostics"
         },
+        "customALGoFiles": {
+            "description": "An object containing the custom AL-Go files configuration. See https://aka.ms/ALGoSettings#customALGoFiles",
+            "type": "object",
+            "properties": {
+                "filesToInclude": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "sourceFolder": {
+                                "type": "string",
+                                "description": "The source folder from which to update files, relative to the template repository root."
+                            },
+                            "filter": {
+                                "type": "string",
+                                "description": "A filter string to select which files to update. It can contain '*' and '?' wildcards."
+                            },
+                            "destinationFolder": {
+                                "type": "string",
+                                "description": "The destination folder where the files should be updated, relative to the repository root. If not specified, defaults to the same as the source file folder."
+                            },
+                            "perProject": {
+                                "type": "boolean",
+                                "description": "Indicates whether the file update should be applied per project. In that case, the destinationFolder is considered relative to each project folder."
+                            }
+                        }
+                    }
+                },
+                "filesToExclude": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "sourceFolder": {
+                                "type": "string",
+                                "description": "The source folder from which to exclude files, relative to the template repository root."
+                            },
+                            "filter": {
+                                "type": "string",
+                                "description": "A filter string to select which files to exclude. It can contain '*' and '?' wildcards."
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "workflowDefaultInputs": {
             "type": "array",
             "items": {

Actions/AL-Go-Helper.ps1

@@ -2184,6 +2184,12 @@ function ConnectAz {
     }
 }
 
+<#
+    .SYNOPSIS
+    Output a message and an array of strings in a formatted way.
+
+    Deprecated: Use OutputArray function from DebugLogHelper module.
+#>
 function OutputMessageAndArray {
     Param(
         [string] $message,