Enhance customALGoFiles feature by OleWunschmann · Pull Request #2273 · microsoft/AL-Go

OleWunschmann · 2026-06-03T15:24:31Z

❔What, Why & How

New file removal feature:

Added a new filesToRemove field to the customALGoFiles section in both the in-memory settings and the JSON schema, allowing users to specify files that should always be removed from the repository during updates, regardless of their presence in the template. (Actions/.Modules/ReadSettings.psm1, Actions/.Modules/settings.schema.json) [1] [2]

Update logic improvements:

Refactored the logic in GetFilesToUpdate and related helper functions to merge filesToInclude, filesToExclude, and filesToRemove from both repository and template settings, propagate removals from upstream templates, and correctly resolve file paths for removal operations. (Actions/CheckForUpdates/CheckForUpdates.HelperFunctions.ps1) [1] [2] [3]
Added the ResolveFilePathsInDestinationFolder function to accurately identify files for removal in the target repository, supporting per-project and destination-relative path resolution. (Actions/CheckForUpdates/CheckForUpdates.HelperFunctions.ps1)

Telemetry and settings handling:

Enhanced telemetry to track usage of filesToInclude, filesToExclude, and filesToRemove for both repository and template settings, providing better insights into feature adoption. (Actions/CheckForUpdates/CheckForUpdates.HelperFunctions.ps1)
Updated the call to ReadSettings to include the -trigger parameter, ensuring settings are read with the correct context. (Actions/CheckForUpdates/CheckForUpdates.ps1)
Prepared for template settings merging by initializing $templateRepoSettings and adjusting template download logic. (Actions/CheckForUpdates/CheckForUpdates.ps1)

Related to discussion: #2227

✅ Checklist

Add tests (E2E, unit tests)
Update RELEASENOTES.md
Update documentation (e.g. for new settings or scenarios)
Add telemetry

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

This PR enhances the customALGoFiles behavior during “Update AL-Go System Files”, adding support for unconditional removals (filesToRemove) and improving custom-template behavior by merging template settings directly and resolving files from the original AL-Go template where applicable.

Changes:

Add customALGoFiles.filesToRemove support end-to-end (schema, defaults, resolution logic, docs, and release notes).
Update CheckForUpdates to read template repo settings via ReadSettings and merge template settings during file resolution.
Expand automated coverage (unit + e2e) for include/exclude/remove resolution and custom-template propagation.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
e2eTests/scenarios/CustomTemplate/runtest.ps1	Extends e2e scenario to validate custom-template file include/exclude/remove propagation and workflow presence.
Tests/CheckForUpdates.Action.Test.ps1	Adds unit tests for destination-folder resolution and expanded `GetFilesToUpdate` behaviors (including `filesToRemove`).
Actions/CheckForUpdates/CheckForUpdates.ps1	Updates settings reading (incl. `trigger`) and wires template settings + `filesToRemove` into update/removal flow.
Actions/CheckForUpdates/CheckForUpdates.HelperFunctions.ps1	Implements `ResolveFilePathsInDestinationFolder` and extends `GetFilesToUpdate` to produce include/exclude/remove lists.
Actions/.Modules/settings.schema.json	Extends settings schema with `customALGoFiles.filesToRemove` and clarifying descriptions.
Actions/.Modules/ReadSettings.psm1	Adds default `filesToRemove` array under `customALGoFiles`.
Scenarios/settings.md	Documents `customALGoFiles.filesToRemove` in settings reference.
Scenarios/CustomizingALGoForGitHub.md	Adds conceptual docs + examples for original-template resolution and `filesToRemove`.
RELEASENOTES.md	Documents enhanced `customALGoFiles` behavior and new `filesToRemove`.

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

OleWunschmann · 2026-06-09T16:28:49Z

+- `sourceFolder`: A path to a folder, relative to the template, where to look for files. If not specified the root folder is implied. `*` characters are not supported. _Example_: `.github/workflows`.
+- `filter`: A string to use for filtering in the specified source path. It can contain `*` and `?` wildcards. _Example_: `deprecated-*.yaml` or `oldScript.ps1`.
+- `destinationFolder`: A path to a folder, relative to the end repository, where the files are located. If not specified, defaults to the same as the source file folder. _Example_: `.github/workflows`.
+- `perProject`: A boolean that indicates whether the matched files should be removed for all available AL-Go projects. In that case, `destinationFolder` is relative to the project folder. _Example_: `.AL-Go/scripts`.


I added the support for destinationName based on the same property of filesToInclude, which is also not documented or defined in the schema.

@mazhelez What do you think about adding the property for filesToInclude and filesToRemove in the documentation and schema?

I remember we discussed having filesToRemove but there was a scenario that didn't make sense. I'd need to revisit that discussion.

I extended the schema and documentation for property destinationName.

OleWunschmann · 2026-06-09T16:28:58Z

+                            "sourceFolder": {
+                                "type": "string",
+                                "description": "The source folder from which to remove files, relative to the template repository root."
+                            },
+                            "filter": {
+                                "type": "string",
+                                "description": "A filter string to select which files to remove. It can contain '*' and '?' wildcards."
+                            },
+                            "destinationFolder": {
+                                "type": "string",
+                                "description": "The destination folder where the files should be removed, relative to the repository root."
+                            },
+                            "perProject": {
+                                "type": "boolean",
+                                "description": "Indicates whether the removal should be applied per project. In that case, destinationFolder is relative to each project folder."
+                            }
+                        }


I added the support for destinationName based on the same property of filesToInclude, which is also not documented or defined in the schema.

@mazhelez What do you think about adding the property for filesToInclude and filesToRemove in the documentation and schema?

I extended the schema and documentation for property destinationName

OleWunschmann · 2026-06-09T16:31:13Z

@mazhelez The failing PS5 tests should be fixed now.

…es-feature

spetersenms · 2026-07-07T11:01:16Z

@@ -1,3 +1,13 @@
+### Enhanced `customALGoFiles` setting


A new version of AL-Go (v9.1) has been released.

Please move your release notes changes to above the ## v9.1 section in the RELEASENOTES.md file.

This ensures your changes are included in the next release rather than being listed under an already-released version.

@spetersenms Fixed

spetersenms · 2026-07-07T11:06:31Z

@@ -1,3 +1,13 @@
+### Enhanced `customALGoFiles` setting


A new version of AL-Go (v9.1) has been released.

Please move your release notes changes to above the ## v9.1 section in the RELEASENOTES.md file.

This ensures your changes are included in the next release rather than being listed under an already-released version.

@spetersenms Fixed

…es-feature

Enhance customALGoFiles feature (#3)

0d9e05e

Copilot AI review requested due to automatic review settings June 3, 2026 15:24

OleWunschmann requested a review from a team as a code owner June 3, 2026 15:24

Copilot AI reviewed Jun 3, 2026

View reviewed changes

OleWunschmann added 2 commits June 3, 2026 17:35

fixed typo

73f4ef3

fixed function description

bb38962

mazhelez requested a review from Copilot June 8, 2026 09:25

Copilot started reviewing on behalf of mazhelez June 8, 2026 09:25 View session

Copilot AI reviewed Jun 8, 2026

View reviewed changes

OleWunschmann and others added 2 commits June 9, 2026 18:17

Fixed tests for ps5 and string-prefix check for folder traversal

50ad11c

Merge branch 'main' into enhance-customALGoFiles-feature

7aa8766

OleWunschmann and others added 5 commits June 12, 2026 11:12

Merge branch 'main' into enhance-customALGoFiles-feature

f7496cc

Merge branch 'main' into enhance-customALGoFiles-feature

11e2efc

Merge branch 'main' into enhance-customALGoFiles-feature

b021013

Merge branch 'main' into enhance-customALGoFiles-feature

025747e

Merge remote-tracking branch 'origin/main' into enhance-customALGoFil…

dd1771a

…es-feature

spetersenms reviewed Jul 7, 2026

View reviewed changes

Merge remote-tracking branch 'origin/main' into enhance-customALGoFil…

2d24972

…es-feature

OleWunschmann requested a review from spetersenms July 9, 2026 17:11

OleWunschmann added 2 commits July 14, 2026 18:27

Merge remote-tracking branch 'origin/main' into enhance-customALGoFil…

5976abe

…es-feature

Extended settings schema and documentation for "destinationName"

7fa3522

Uh oh!

Conversation

OleWunschmann commented Jun 3, 2026

❔What, Why & How

✅ Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OleWunschmann commented Jun 9, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants