Skip to content

Commit

Permalink
[releases/24.2] Update AL-Go System Files from microsoft/AL-Go-PTE@pr…
Browse files Browse the repository at this point in the history
…eview - 73f489ec1d9a34fa2ed69fbafd5e0ec9bd67f48b (#1852)

Fixes
[AB#420000](https://dynamicssmb2.visualstudio.com/1fcb79e7-ab07-432a-a3c6-6cf5a88ba4a5/_workitems/edit/420000)

## v5.3

### Issues

- Issue 1105 Increment Version Number - repoVersion in
.github/AL-Go-Settings.json is not updated
- Issue 1073 Publish to AppSource - Automated validation: failure
- Issue 980 Allow Scope to be PTE in continuousDeployment for PTE
extensions in Sandbox (enhancement request)
- Issue 1079 AppSource App deployment failes with PerTenantExtensionCop
Error PTE0001 and PTE0002
- Issue 866 Accessing GitHub Environment Variables in DeployToCustom
Scenarios for PowerShell Scripts
- Issue 1083 SyncMode for custom deployments?
- Issue 1109 Why filter deployment settings?
- Fix issue with github ref when running reusable workflows
- Issue 1098 Support for specifying the name of the AZURE_CREDENTIALS
secret by adding a AZURE_CREDENTIALSSecretName setting
- Fix placeholder syntax for git ref in PullRequestHandler.yaml
- Issue 1164 Getting secrets from Azure key vault fails in Preview

### Dependencies to PowerShell modules

AL-Go for GitHub relies on specific PowerShell modules, and the minimum
versions required for these modules are tracked in
[Packages.json](https://raw.githubusercontent.com/microsoft/AL-Go/main/Actions/Packages.json)
file. Should the installed modules on the GitHub runner not meet these
minimum requirements, the necessary modules will be installed as needed.

### Support managed identities and federated credentials

All authentication context secrets now supports managed identities and
federated credentials. See more [here](Scenarios/secrets.md).
Furthermore, you can now use https://aka.ms/algosecrets#authcontext to
learn more about the formatting of that secret.

### Business Central Performance Toolkit Test Result Viewer

In the summary after a Test Run, you now also have the result of
performance tests.

### Support Ubuntu runners for all AL-Go workflows

Previously, the workflows "Update AL-Go System Files" and
"TroubleShooting" were hardcoded to always run on `windows-latest` to
prevent deadlocks and security issues.
From now on, `ubuntu-lates` will also be allowed for these mission
critical workflows, when changing the `runs-on` setting. Additionally,
only the value `pwsh` for `shell` setting is allowed when using
`ubuntu-latest` runners.

### Updated AL-Go telemetry

AL-Go for GitHub now includes a new telemetry module. For detailed
information on how to enable or disable telemetry and to see what data
AL-Go logs, check out [this
article](https://github.com/microsoft/AL-Go/blob/main/Scenarios/EnablingTelemetry.md).

### New Settings

- `deployTo<environmentName>`: is not really new, but has a new
property:

- **Scope** = specifies the scope of the deployment: Dev, PTE. If not
specified, AL-Go for GitHub will always use the Dev Scope for AppSource
Apps, but also for PTEs when deploying to sandbox environments when
impersonation (refreshtoken) is used for authentication.
- **BuildMode** = specifies which buildMode to use for the deployment.
Default is to use the Default buildMode.
- **\<custom>** = custom properties are now supported and will be
transferred to a custom deployment script in the hashtable.

- `bcptThresholds` is a JSON object with properties for the default
thresholds for the Business Central Performance Toolkit

- **DurationWarning** - a warning is issued if the duration of a bcpt
test degrades more than this percentage (default 10)
- **DurationError** - an error is issued if the duration of a bcpt test
degrades more than this percentage (default 25)
- **NumberOfSqlStmtsWarning** - a warning is issued if the number of SQL
statements from a bcpt test increases more than this percentage (default
5)
- **NumberOfSqlStmtsError** - an error is issued if the number of SQL
statements from a bcpt test increases more than this percentage (default
10)

> \[!NOTE\]
> 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.

Co-authored-by: bcbuild-github-agent <[email protected]>
  • Loading branch information
bcbuild-github-agent and bcbuild-github-agent authored Aug 21, 2024
1 parent 73c75d3 commit b935e5b
Show file tree
Hide file tree
Showing 23 changed files with 109 additions and 110 deletions.
2 changes: 1 addition & 1 deletion .github/AL-Go-Settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,5 +72,5 @@
]
},
"UpdateALGoSystemFilesEnvironment": "Official-Build",
"templateSha": "0fa5d001900cac6ce60dcb2170b620dd3694dafd"
"templateSha": "73f489ec1d9a34fa2ed69fbafd5e0ec9bd67f48b"
}
5 changes: 2 additions & 3 deletions .github/RELEASENOTES.copy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
## preview

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.
## v5.3

### Issues

Expand All @@ -14,6 +12,7 @@ Note that when using the preview version of AL-Go for GitHub, we recommend you U
- Fix issue with github ref when running reusable workflows
- Issue 1098 Support for specifying the name of the AZURE_CREDENTIALS secret by adding a AZURE_CREDENTIALSSecretName setting
- Fix placeholder syntax for git ref in PullRequestHandler.yaml
- Issue 1164 Getting secrets from Azure key vault fails in Preview

### Dependencies to PowerShell modules

Expand Down
40 changes: 20 additions & 20 deletions .github/workflows/CICD.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
workflowDepth: ${{ steps.DetermineWorkflowDepth.outputs.WorkflowDepth }}
steps:
- name: Dump Workflow Information
uses: microsoft/AL-Go/Actions/DumpWorkflowInfo@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/DumpWorkflowInfo@v5.3
with:
shell: powershell

Expand All @@ -56,13 +56,13 @@ jobs:

- name: Initialize the workflow
id: init
uses: microsoft/AL-Go/Actions/WorkflowInitialize@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/WorkflowInitialize@v5.3
with:
shell: powershell

- name: Read settings
id: ReadSettings
uses: microsoft/AL-Go/Actions/ReadSettings@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSettings@v5.3
with:
shell: powershell
get: type, powerPlatformSolutionFolder
Expand All @@ -74,7 +74,7 @@ jobs:
- name: Determine Projects To Build
id: determineProjectsToBuild
uses: microsoft/AL-Go/Actions/DetermineProjectsToBuild@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/DetermineProjectsToBuild@v5.3
with:
shell: powershell
maxBuildDepth: ${{ env.workflowDepth }}
Expand All @@ -87,23 +87,23 @@ jobs:
- name: Determine Delivery Target Secrets
id: DetermineDeliveryTargetSecrets
uses: microsoft/AL-Go/Actions/DetermineDeliveryTargets@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/DetermineDeliveryTargets@v5.3
with:
shell: powershell
projectsJson: '${{ steps.determineProjectsToBuild.outputs.ProjectsJson }}'
checkContextSecrets: 'false'

- name: Read secrets
id: ReadSecrets
uses: microsoft/AL-Go/Actions/ReadSecrets@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSecrets@v5.3
with:
shell: powershell
gitHubSecrets: ${{ toJson(secrets) }}
getSecrets: ${{ steps.DetermineDeliveryTargetSecrets.outputs.ContextSecrets }}

- name: Determine Delivery Targets
id: DetermineDeliveryTargets
uses: microsoft/AL-Go/Actions/DetermineDeliveryTargets@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/DetermineDeliveryTargets@v5.3
env:
Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'
with:
Expand All @@ -113,7 +113,7 @@ jobs:

- name: Determine Deployment Environments
id: DetermineDeploymentEnvironments
uses: microsoft/AL-Go/Actions/DetermineDeploymentEnvironments@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/DetermineDeploymentEnvironments@v5.3
env:
GITHUB_TOKEN: ${{ github.token }}
with:
Expand All @@ -129,13 +129,13 @@ jobs:
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7

- name: Read settings
uses: microsoft/AL-Go/Actions/ReadSettings@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSettings@v5.3
with:
shell: powershell
get: templateUrl

- name: Check for updates to AL-Go system files
uses: microsoft/AL-Go/Actions/CheckForUpdates@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/CheckForUpdates@v5.3
with:
shell: powershell
templateUrl: ${{ env.templateUrl }}
Expand Down Expand Up @@ -210,7 +210,7 @@ jobs:
path: '.artifacts'

- name: Read settings
uses: microsoft/AL-Go/Actions/ReadSettings@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSettings@v5.3
with:
shell: powershell

Expand All @@ -219,7 +219,7 @@ jobs:
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0

- name: Build Reference Documentation
uses: microsoft/AL-Go/Actions/BuildReferenceDocumentation@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/BuildReferenceDocumentation@v5.3
with:
shell: powershell
artifacts: '.artifacts'
Expand Down Expand Up @@ -256,7 +256,7 @@ jobs:
path: '.artifacts'

- name: Read settings
uses: microsoft/AL-Go/Actions/ReadSettings@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSettings@v5.3
with:
shell: ${{ matrix.shell }}
get: type,powerPlatformSolutionFolder
Expand All @@ -270,15 +270,15 @@ jobs:
- name: Read secrets
id: ReadSecrets
uses: microsoft/AL-Go/Actions/ReadSecrets@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSecrets@v5.3
with:
shell: ${{ matrix.shell }}
gitHubSecrets: ${{ toJson(secrets) }}
getSecrets: '${{ steps.envName.outputs.envName }}-AuthContext,${{ steps.envName.outputs.envName }}_AuthContext,AuthContext'

- name: Deploy to Business Central
id: Deploy
uses: microsoft/AL-Go/Actions/Deploy@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/Deploy@v5.3
env:
Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'
with:
Expand All @@ -290,7 +290,7 @@ jobs:

- name: Deploy to Power Platform
if: env.type == 'PTE' && env.powerPlatformSolutionFolder != ''
uses: microsoft/AL-Go/Actions/DeployPowerPlatform@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/DeployPowerPlatform@v5.3
env:
Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'
with:
Expand Down Expand Up @@ -318,20 +318,20 @@ jobs:
path: '.artifacts'

- name: Read settings
uses: microsoft/AL-Go/Actions/ReadSettings@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSettings@v5.3
with:
shell: powershell

- name: Read secrets
id: ReadSecrets
uses: microsoft/AL-Go/Actions/ReadSecrets@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSecrets@v5.3
with:
shell: powershell
gitHubSecrets: ${{ toJson(secrets) }}
getSecrets: '${{ matrix.deliveryTarget }}Context'

- name: Deliver
uses: microsoft/AL-Go/Actions/Deliver@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/Deliver@v5.3
env:
Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'
with:
Expand All @@ -351,7 +351,7 @@ jobs:

- name: Finalize the workflow
id: PostProcess
uses: microsoft/AL-Go/Actions/WorkflowPostProcess@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/WorkflowPostProcess@v5.3
env:
GITHUB_TOKEN: ${{ github.token }}
with:
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/DeployReferenceDocumentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ jobs:

- name: Initialize the workflow
id: init
uses: microsoft/AL-Go/Actions/WorkflowInitialize@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/WorkflowInitialize@v5.3
with:
shell: powershell

- name: Read settings
uses: microsoft/AL-Go/Actions/ReadSettings@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSettings@v5.3
with:
shell: powershell

- name: Determine Deployment Environments
id: DetermineDeploymentEnvironments
uses: microsoft/AL-Go/Actions/DetermineDeploymentEnvironments@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/DetermineDeploymentEnvironments@v5.3
env:
GITHUB_TOKEN: ${{ github.token }}
with:
Expand All @@ -54,7 +54,7 @@ jobs:
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0

- name: Build Reference Documentation
uses: microsoft/AL-Go/Actions/BuildReferenceDocumentation@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/BuildReferenceDocumentation@v5.3
with:
shell: powershell
artifacts: 'latest'
Expand All @@ -71,7 +71,7 @@ jobs:

- name: Finalize the workflow
if: always()
uses: microsoft/AL-Go/Actions/WorkflowPostProcess@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/WorkflowPostProcess@v5.3
env:
GITHUB_TOKEN: ${{ github.token }}
with:
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/IncrementVersionNumber.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
runs-on: [ windows-latest ]
steps:
- name: Dump Workflow Information
uses: microsoft/AL-Go/Actions/DumpWorkflowInfo@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/DumpWorkflowInfo@v5.3
with:
shell: powershell

Expand All @@ -50,26 +50,26 @@ jobs:

- name: Initialize the workflow
id: init
uses: microsoft/AL-Go/Actions/WorkflowInitialize@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/WorkflowInitialize@v5.3
with:
shell: powershell

- name: Read settings
uses: microsoft/AL-Go/Actions/ReadSettings@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSettings@v5.3
with:
shell: powershell

- name: Read secrets
id: ReadSecrets
uses: microsoft/AL-Go/Actions/ReadSecrets@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSecrets@v5.3
with:
shell: powershell
gitHubSecrets: ${{ toJson(secrets) }}
getSecrets: 'TokenForPush'
useGhTokenWorkflowForPush: '${{ github.event.inputs.useGhTokenWorkflow }}'

- name: Increment Version Number
uses: microsoft/AL-Go/Actions/IncrementVersionNumber@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/IncrementVersionNumber@v5.3
with:
shell: powershell
token: ${{ steps.ReadSecrets.outputs.TokenForPush }}
Expand All @@ -79,7 +79,7 @@ jobs:

- name: Finalize the workflow
if: always()
uses: microsoft/AL-Go/Actions/WorkflowPostProcess@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/WorkflowPostProcess@v5.3
env:
GITHUB_TOKEN: ${{ github.token }}
with:
Expand Down
14 changes: 7 additions & 7 deletions .github/workflows/PullRequestHandler.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
if: (github.event.pull_request.base.repo.full_name != github.event.pull_request.head.repo.full_name) && (github.event_name != 'pull_request')
runs-on: windows-latest
steps:
- uses: microsoft/AL-Go/Actions/VerifyPRChanges@75ef430ead72a4c0c4753fb328ecf0257c20c510
- uses: microsoft/AL-Go-Actions/VerifyPRChanges@v5.3

Initialization:
needs: [ PregateCheck ]
Expand All @@ -45,7 +45,7 @@ jobs:
telemetryScopeJson: ${{ steps.init.outputs.telemetryScopeJson }}
steps:
- name: Dump Workflow Information
uses: microsoft/AL-Go/Actions/DumpWorkflowInfo@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/DumpWorkflowInfo@v5.3
with:
shell: powershell

Expand All @@ -57,13 +57,13 @@ jobs:

- name: Initialize the workflow
id: init
uses: microsoft/AL-Go/Actions/WorkflowInitialize@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/WorkflowInitialize@v5.3
with:
shell: powershell

- name: Read settings
id: ReadSettings
uses: microsoft/AL-Go/Actions/ReadSettings@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/ReadSettings@v5.3
with:
shell: powershell

Expand All @@ -74,7 +74,7 @@ jobs:
- name: Determine Projects To Build
id: determineProjectsToBuild
uses: microsoft/AL-Go/Actions/DetermineProjectsToBuild@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/DetermineProjectsToBuild@v5.3
with:
shell: powershell
maxBuildDepth: ${{ env.workflowDepth }}
Expand Down Expand Up @@ -133,15 +133,15 @@ jobs:
steps:
- name: Pull Request Status Check
id: PullRequestStatusCheck
uses: microsoft/AL-Go/Actions/PullRequestStatusCheck@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/PullRequestStatusCheck@v5.3
env:
GITHUB_TOKEN: ${{ github.token }}
with:
shell: powershell

- name: Finalize the workflow
id: PostProcess
uses: microsoft/AL-Go/Actions/WorkflowPostProcess@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/WorkflowPostProcess@v5.3
if: success() || failure()
env:
GITHUB_TOKEN: ${{ github.token }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/Troubleshooting.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
lfs: true

- name: Troubleshooting
uses: microsoft/AL-Go/Actions/Troubleshooting@75ef430ead72a4c0c4753fb328ecf0257c20c510
uses: microsoft/AL-Go-Actions/Troubleshooting@v5.3
with:
shell: powershell
gitHubSecrets: ${{ toJson(secrets) }}
Expand Down
Loading

0 comments on commit b935e5b

Please sign in to comment.