Skip to content

Commit 279f0d2

Browse files
[main] Update AL-Go System Files from microsoft/AL-Go-PTE@preview - bcf5ae3b4204b8687d8afc14a766329e684664cb / Related to AB#539394
1 parent 48d1d13 commit 279f0d2

File tree

23 files changed

+148
-159
lines changed

23 files changed

+148
-159
lines changed

.github/AL-Go-Settings.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
]
7474
},
7575
"UpdateALGoSystemFilesEnvironment": "Official-Build",
76-
"templateSha": "f38e373bfc51cc2349114b04a159f7179de47502",
76+
"templateSha": "bcf5ae3b4204b8687d8afc14a766329e684664cb",
7777
"commitOptions": {
7878
"messageSuffix": "Related to AB#539394",
7979
"pullRequestAutoMerge": true,

.github/RELEASENOTES.copy.md

+25-8
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,31 @@
22

33
Note that when using the preview version of AL-Go for GitHub, we recommend you Update your AL-Go system files, as soon as possible when informed that an update is available.
44

5+
### Deprecations
6+
7+
- `cleanModePreProcessorSymbols` will be removed after April 1st 2025. Use [Conditional Settings](https://aka.ms/algosettings#conditional-settings) instead, specifying buildModes and the `preProcessorSymbols` setting. Read [this](./DEPRECATIONS.md) for more information.
8+
59
### Issues
610

711
- It is now possible to skip the modification of dependency version numbers when running the Increment Version number workflow or the Create Release workflow
812

13+
### New Repository Settings
14+
15+
- [`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.
16+
- [`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](https://aka.ms/algosettings#where-are-the-settings-located) or in [conditional settings](https://aka.ms/algosettings#conditional-settings).
17+
918
### New Versioning Strategy
1019

1120
Setting versioning strategy to 3 will allow 3 segments of the version number to be defined in app.json and repoVersion. Only the 4th segment (Revision) will be defined by the GitHub [run_number](https://go.microsoft.com/fwlink/?linkid=2217416&clcid=0x409) for the CI/CD workflow. Increment version number and Create Release now also supports the ability to set a third segment to the RepoVersion and appversion in app.json.
1221

22+
### Change in published artifacts
23+
24+
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 short lived artifacts generated are controlled by a settings called [`shortLivedArtifactsRetentionDays`](https://aka.ms/algosettings#shortLivedArtifactsRetentionDays).
25+
26+
### Preprocessor symbols
27+
28+
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.
29+
1330
## v6.2
1431

1532
### Issues
@@ -142,7 +159,7 @@ AL-Go for GitHub now includes a new telemetry module. For detailed information o
142159
- **NumberOfSqlStmtsWarning** - a warning is issued if the number of SQL statements from a bcpt test increases more than this percentage (default 5)
143160
- **NumberOfSqlStmtsError** - an error is issued if the number of SQL statements from a bcpt test increases more than this percentage (default 10)
144161

145-
> \[!NOTE\]
162+
> [!NOTE]
146163
> Duration thresholds are subject to varying results depending on the performance of the agent running the tests. Number of SQL statements executed by a test is often the most reliable indicator of performance degredation.
147164
148165
## v5.2
@@ -169,7 +186,7 @@ AL-Go for GitHub now includes a new telemetry module. For detailed information o
169186
- **Pull PowerPlatform Changes** for pulling changes from your PowerPlatform development environment into your AL-Go for GitHub repository
170187
- **Push PowerPlatform Changes** for pushing changes from your AL-Go for GitHub repository to your PowerPlatform development environment
171188

172-
> \[!NOTE\]
189+
> [!NOTE]
173190
> PowerPlatform workflows are only available in the PTE template and will be removed if no PowerPlatformSolutionFolder is defined in settings.
174191
175192
### New Scenarios (Documentation)
@@ -179,7 +196,7 @@ AL-Go for GitHub now includes a new telemetry module. For detailed information o
179196
- [Try one of the Business Central and Power Platform samples](https://github.com/microsoft/AL-Go/blob/main/Scenarios/TryPowerPlatformSamples.md)
180197
- [Publish To AppSource](https://github.com/microsoft/AL-Go/blob/main/Scenarios/PublishToAppSource.md)
181198

182-
> \[!NOTE\]
199+
> [!NOTE]
183200
> PowerPlatform functionality are only available in the PTE template.
184201
185202
## v5.1
@@ -317,8 +334,8 @@ AL-Go for GitHub allows you to build and test using insider builds without any e
317334

318335
- `enableExternalRulesets`: set this setting to true if you want to allow AL-Go to automatically download external references in rulesets.
319336
- `deliverTo<deliveryTarget>`: is not really new, but has new properties and wasn't documented. The complete list of properties is here (note that some properties are deliveryTarget specific):
320-
- **Branches** = an array of branch patterns, which are allowed to deliver to this deliveryTarget. (Default \[ "main" \])
321-
- **CreateContainerIfNotExist** = *\[Only for DeliverToStorage\]* Create Blob Storage Container if it doesn't already exist. (Default false)
337+
- **Branches** = an array of branch patterns, which are allowed to deliver to this deliveryTarget. (Default [ "main" ])
338+
- **CreateContainerIfNotExist** = *[Only for DeliverToStorage]* Create Blob Storage Container if it doesn't already exist. (Default false)
322339

323340
### Deployment
324341

@@ -359,7 +376,7 @@ Earlier, you could also specify the projects you want to deploy to an environmen
359376
- `deployTo<environmentName>`: is not really new, but has new properties. The complete list of properties is here:
360377
- **EnvironmentType** = specifies the type of environment. The environment type can be used to invoke a custom deployment. (Default SaaS)
361378
- **EnvironmentName** = specifies the "real" name of the environment if it differs from the GitHub environment
362-
- **Branches** = an array of branch patterns, which are allowed to deploy to this environment. (Default \[ "main" \])
379+
- **Branches** = an array of branch patterns, which are allowed to deploy to this environment. (Default [ "main" ])
363380
- **Projects** = In multi-project repositories, this property can be a comma separated list of project patterns to deploy to this environment. (Default \*)
364381
- **SyncMode** = ForceSync if deployment to this environment should happen with ForceSync, else Add. If deploying to the development endpoint you can also specify Development or Clean. (Default Add)
365382
- **ContinuousDeployment** = true if this environment should be used for continuous deployment, else false. (Default: AL-Go will continuously deploy to sandbox environments or environments, which doesn't end in (PROD) or (FAT)
@@ -417,8 +434,8 @@ Now, you can set the checkbox called Use GhTokenWorkflow to allowing you to use
417434

418435
### New Settings
419436

420-
- `keyVaultCodesignCertificateName`: With this setting you can delegate the codesigning to an Azure Key Vault. This can be useful if your certificate has to be stored in a Hardware Security Module
421-
- `PullRequestTrigger`: With this setting you can set which trigger to use for Pull Request Builds. By default AL-Go will use pull_request_target.
437+
- `keyVaultCodesignCertificateName`: With this setting you can delegate the codesigning to an Azure Key Vault. This can be useful if your certificate has to be stored in a Hardware Security Module
438+
- `PullRequestTrigger`: With this setting you can set which trigger to use for Pull Request Builds. By default AL-Go will use pull_request_target.
422439

423440
### New Actions
424441

.github/workflows/CICD.yaml

+21-25
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
workflowDepth: ${{ steps.DetermineWorkflowDepth.outputs.WorkflowDepth }}
4646
steps:
4747
- name: Dump Workflow Information
48-
uses: microsoft/AL-Go/Actions/DumpWorkflowInfo@471b88b68863d06568efb833d74b02f0879b1c89
48+
uses: microsoft/AL-Go/Actions/DumpWorkflowInfo@44100a28d57e2c582859205900ac519d9d76c57c
4949
with:
5050
shell: powershell
5151

@@ -56,21 +56,21 @@ jobs:
5656

5757
- name: Initialize the workflow
5858
id: init
59-
uses: microsoft/AL-Go/Actions/WorkflowInitialize@471b88b68863d06568efb833d74b02f0879b1c89
59+
uses: microsoft/AL-Go/Actions/WorkflowInitialize@44100a28d57e2c582859205900ac519d9d76c57c
6060
with:
6161
shell: powershell
6262

6363
- name: Read settings
6464
id: ReadSettings
65-
uses: microsoft/AL-Go/Actions/ReadSettings@471b88b68863d06568efb833d74b02f0879b1c89
65+
uses: microsoft/AL-Go/Actions/ReadSettings@44100a28d57e2c582859205900ac519d9d76c57c
6666
with:
6767
shell: powershell
6868
get: type,powerPlatformSolutionFolder,useGitSubmodules
6969

7070
- name: Read submodules token
7171
id: ReadSubmodulesToken
7272
if: env.useGitSubmodules != 'false' && env.useGitSubmodules != ''
73-
uses: microsoft/AL-Go/Actions/ReadSecrets@471b88b68863d06568efb833d74b02f0879b1c89
73+
uses: microsoft/AL-Go/Actions/ReadSecrets@44100a28d57e2c582859205900ac519d9d76c57c
7474
with:
7575
shell: powershell
7676
gitHubSecrets: ${{ toJson(secrets) }}
@@ -91,7 +91,7 @@ jobs:
9191
9292
- name: Determine Projects To Build
9393
id: determineProjectsToBuild
94-
uses: microsoft/AL-Go/Actions/DetermineProjectsToBuild@471b88b68863d06568efb833d74b02f0879b1c89
94+
uses: microsoft/AL-Go/Actions/DetermineProjectsToBuild@44100a28d57e2c582859205900ac519d9d76c57c
9595
with:
9696
shell: powershell
9797
maxBuildDepth: ${{ env.workflowDepth }}
@@ -104,23 +104,23 @@ jobs:
104104
105105
- name: Determine Delivery Target Secrets
106106
id: DetermineDeliveryTargetSecrets
107-
uses: microsoft/AL-Go/Actions/DetermineDeliveryTargets@471b88b68863d06568efb833d74b02f0879b1c89
107+
uses: microsoft/AL-Go/Actions/DetermineDeliveryTargets@44100a28d57e2c582859205900ac519d9d76c57c
108108
with:
109109
shell: powershell
110110
projectsJson: '${{ steps.determineProjectsToBuild.outputs.ProjectsJson }}'
111111
checkContextSecrets: 'false'
112112

113113
- name: Read secrets
114114
id: ReadSecrets
115-
uses: microsoft/AL-Go/Actions/ReadSecrets@471b88b68863d06568efb833d74b02f0879b1c89
115+
uses: microsoft/AL-Go/Actions/ReadSecrets@44100a28d57e2c582859205900ac519d9d76c57c
116116
with:
117117
shell: powershell
118118
gitHubSecrets: ${{ toJson(secrets) }}
119119
getSecrets: ${{ steps.DetermineDeliveryTargetSecrets.outputs.ContextSecrets }}
120120

121121
- name: Determine Delivery Targets
122122
id: DetermineDeliveryTargets
123-
uses: microsoft/AL-Go/Actions/DetermineDeliveryTargets@471b88b68863d06568efb833d74b02f0879b1c89
123+
uses: microsoft/AL-Go/Actions/DetermineDeliveryTargets@44100a28d57e2c582859205900ac519d9d76c57c
124124
env:
125125
Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'
126126
with:
@@ -130,7 +130,7 @@ jobs:
130130

131131
- name: Determine Deployment Environments
132132
id: DetermineDeploymentEnvironments
133-
uses: microsoft/AL-Go/Actions/DetermineDeploymentEnvironments@471b88b68863d06568efb833d74b02f0879b1c89
133+
uses: microsoft/AL-Go/Actions/DetermineDeploymentEnvironments@44100a28d57e2c582859205900ac519d9d76c57c
134134
env:
135135
GITHUB_TOKEN: ${{ github.token }}
136136
with:
@@ -146,13 +146,13 @@ jobs:
146146
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
147147

148148
- name: Read settings
149-
uses: microsoft/AL-Go/Actions/ReadSettings@471b88b68863d06568efb833d74b02f0879b1c89
149+
uses: microsoft/AL-Go/Actions/ReadSettings@44100a28d57e2c582859205900ac519d9d76c57c
150150
with:
151151
shell: powershell
152152
get: templateUrl
153153

154154
- name: Check for updates to AL-Go system files
155-
uses: microsoft/AL-Go/Actions/CheckForUpdates@471b88b68863d06568efb833d74b02f0879b1c89
155+
uses: microsoft/AL-Go/Actions/CheckForUpdates@44100a28d57e2c582859205900ac519d9d76c57c
156156
with:
157157
shell: powershell
158158
templateUrl: ${{ env.templateUrl }}
@@ -176,8 +176,6 @@ jobs:
176176
buildMode: ${{ matrix.buildMode }}
177177
projectDependenciesJson: ${{ needs.Initialization.outputs.projectDependenciesJson }}
178178
secrets: 'licenseFileUrl,codeSignCertificateUrl,*codeSignCertificatePassword,keyVaultCertificateUrl,*keyVaultCertificatePassword,keyVaultClientId,gitHubPackagesContext,applicationInsightsConnectionString'
179-
publishThisBuildArtifacts: ${{ needs.Initialization.outputs.workflowDepth > 1 }}
180-
publishArtifacts: ${{ github.ref_name == 'main' || startswith(github.ref_name, 'release/') || startswith(github.ref_name, 'releases/') || needs.Initialization.outputs.deliveryTargetsJson != '[]' || needs.Initialization.outputs.environmentCount > 0 }}
181179
signArtifacts: true
182180
useArtifactCache: true
183181

@@ -199,8 +197,6 @@ jobs:
199197
buildMode: ${{ matrix.buildMode }}
200198
projectDependenciesJson: ${{ needs.Initialization.outputs.projectDependenciesJson }}
201199
secrets: 'licenseFileUrl,codeSignCertificateUrl,*codeSignCertificatePassword,keyVaultCertificateUrl,*keyVaultCertificatePassword,keyVaultClientId,gitHubPackagesContext,applicationInsightsConnectionString'
202-
publishThisBuildArtifacts: ${{ needs.Initialization.outputs.workflowDepth > 1 }}
203-
publishArtifacts: ${{ github.ref_name == 'main' || startswith(github.ref_name, 'release/') || startswith(github.ref_name, 'releases/') || needs.Initialization.outputs.deliveryTargetsJson != '[]' || needs.Initialization.outputs.environmentCount > 0 }}
204200
signArtifacts: true
205201
useArtifactCache: true
206202

@@ -227,7 +223,7 @@ jobs:
227223
path: '.artifacts'
228224

229225
- name: Read settings
230-
uses: microsoft/AL-Go/Actions/ReadSettings@471b88b68863d06568efb833d74b02f0879b1c89
226+
uses: microsoft/AL-Go/Actions/ReadSettings@44100a28d57e2c582859205900ac519d9d76c57c
231227
with:
232228
shell: powershell
233229

@@ -236,7 +232,7 @@ jobs:
236232
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
237233

238234
- name: Build Reference Documentation
239-
uses: microsoft/AL-Go/Actions/BuildReferenceDocumentation@471b88b68863d06568efb833d74b02f0879b1c89
235+
uses: microsoft/AL-Go/Actions/BuildReferenceDocumentation@44100a28d57e2c582859205900ac519d9d76c57c
240236
with:
241237
shell: powershell
242238
artifacts: '.artifacts'
@@ -273,7 +269,7 @@ jobs:
273269
path: '.artifacts'
274270

275271
- name: Read settings
276-
uses: microsoft/AL-Go/Actions/ReadSettings@471b88b68863d06568efb833d74b02f0879b1c89
272+
uses: microsoft/AL-Go/Actions/ReadSettings@44100a28d57e2c582859205900ac519d9d76c57c
277273
with:
278274
shell: ${{ matrix.shell }}
279275
get: type,powerPlatformSolutionFolder
@@ -287,15 +283,15 @@ jobs:
287283
288284
- name: Read secrets
289285
id: ReadSecrets
290-
uses: microsoft/AL-Go/Actions/ReadSecrets@471b88b68863d06568efb833d74b02f0879b1c89
286+
uses: microsoft/AL-Go/Actions/ReadSecrets@44100a28d57e2c582859205900ac519d9d76c57c
291287
with:
292288
shell: ${{ matrix.shell }}
293289
gitHubSecrets: ${{ toJson(secrets) }}
294290
getSecrets: '${{ steps.envName.outputs.envName }}-AuthContext,${{ steps.envName.outputs.envName }}_AuthContext,AuthContext'
295291

296292
- name: Deploy to Business Central
297293
id: Deploy
298-
uses: microsoft/AL-Go/Actions/Deploy@471b88b68863d06568efb833d74b02f0879b1c89
294+
uses: microsoft/AL-Go/Actions/Deploy@44100a28d57e2c582859205900ac519d9d76c57c
299295
env:
300296
Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'
301297
with:
@@ -307,7 +303,7 @@ jobs:
307303

308304
- name: Deploy to Power Platform
309305
if: env.type == 'PTE' && env.powerPlatformSolutionFolder != ''
310-
uses: microsoft/AL-Go/Actions/DeployPowerPlatform@471b88b68863d06568efb833d74b02f0879b1c89
306+
uses: microsoft/AL-Go/Actions/DeployPowerPlatform@44100a28d57e2c582859205900ac519d9d76c57c
311307
env:
312308
Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'
313309
with:
@@ -335,20 +331,20 @@ jobs:
335331
path: '.artifacts'
336332

337333
- name: Read settings
338-
uses: microsoft/AL-Go/Actions/ReadSettings@471b88b68863d06568efb833d74b02f0879b1c89
334+
uses: microsoft/AL-Go/Actions/ReadSettings@44100a28d57e2c582859205900ac519d9d76c57c
339335
with:
340336
shell: powershell
341337

342338
- name: Read secrets
343339
id: ReadSecrets
344-
uses: microsoft/AL-Go/Actions/ReadSecrets@471b88b68863d06568efb833d74b02f0879b1c89
340+
uses: microsoft/AL-Go/Actions/ReadSecrets@44100a28d57e2c582859205900ac519d9d76c57c
345341
with:
346342
shell: powershell
347343
gitHubSecrets: ${{ toJson(secrets) }}
348344
getSecrets: '${{ matrix.deliveryTarget }}Context'
349345

350346
- name: Deliver
351-
uses: microsoft/AL-Go/Actions/Deliver@471b88b68863d06568efb833d74b02f0879b1c89
347+
uses: microsoft/AL-Go/Actions/Deliver@44100a28d57e2c582859205900ac519d9d76c57c
352348
env:
353349
Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'
354350
with:
@@ -368,7 +364,7 @@ jobs:
368364

369365
- name: Finalize the workflow
370366
id: PostProcess
371-
uses: microsoft/AL-Go/Actions/WorkflowPostProcess@471b88b68863d06568efb833d74b02f0879b1c89
367+
uses: microsoft/AL-Go/Actions/WorkflowPostProcess@44100a28d57e2c582859205900ac519d9d76c57c
372368
env:
373369
GITHUB_TOKEN: ${{ github.token }}
374370
with:

.github/workflows/DeployReferenceDocumentation.yaml

+5-5
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,18 @@ jobs:
3030

3131
- name: Initialize the workflow
3232
id: init
33-
uses: microsoft/AL-Go/Actions/WorkflowInitialize@471b88b68863d06568efb833d74b02f0879b1c89
33+
uses: microsoft/AL-Go/Actions/WorkflowInitialize@44100a28d57e2c582859205900ac519d9d76c57c
3434
with:
3535
shell: powershell
3636

3737
- name: Read settings
38-
uses: microsoft/AL-Go/Actions/ReadSettings@471b88b68863d06568efb833d74b02f0879b1c89
38+
uses: microsoft/AL-Go/Actions/ReadSettings@44100a28d57e2c582859205900ac519d9d76c57c
3939
with:
4040
shell: powershell
4141

4242
- name: Determine Deployment Environments
4343
id: DetermineDeploymentEnvironments
44-
uses: microsoft/AL-Go/Actions/DetermineDeploymentEnvironments@471b88b68863d06568efb833d74b02f0879b1c89
44+
uses: microsoft/AL-Go/Actions/DetermineDeploymentEnvironments@44100a28d57e2c582859205900ac519d9d76c57c
4545
env:
4646
GITHUB_TOKEN: ${{ github.token }}
4747
with:
@@ -54,7 +54,7 @@ jobs:
5454
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
5555

5656
- name: Build Reference Documentation
57-
uses: microsoft/AL-Go/Actions/BuildReferenceDocumentation@471b88b68863d06568efb833d74b02f0879b1c89
57+
uses: microsoft/AL-Go/Actions/BuildReferenceDocumentation@44100a28d57e2c582859205900ac519d9d76c57c
5858
with:
5959
shell: powershell
6060
artifacts: 'latest'
@@ -71,7 +71,7 @@ jobs:
7171

7272
- name: Finalize the workflow
7373
if: always()
74-
uses: microsoft/AL-Go/Actions/WorkflowPostProcess@471b88b68863d06568efb833d74b02f0879b1c89
74+
uses: microsoft/AL-Go/Actions/WorkflowPostProcess@44100a28d57e2c582859205900ac519d9d76c57c
7575
env:
7676
GITHUB_TOKEN: ${{ github.token }}
7777
with:

0 commit comments

Comments
 (0)