Enable AL-Go for GitHub on GitHub Enterprise Cloud with data residency

[freddydk]

❔What, Why & How

This pull request introduces comprehensive updates to improve compatibility with GitHub Enterprise (GHE) hosts. The main focus is to ensure that all scripts and workflows dynamically use the correct GitHub server and API URLs, rather than hardcoding references to github.com and api.github.com. This enables repositories using AL-Go for GitHub to work seamlessly on both public GitHub and GHE instances. Additionally, documentation has been updated to clarify support and provide guidance for GHE users.

GitHub Enterprise compatibility and dynamic host resolution:

• All PowerShell scripts and workflow files now use the GITHUB_SERVER_URL and GITHUB_API_URL environment variables instead of hardcoded github.com and api.github.com URLs for REST API calls and repository links. This affects actions such as dependency probing, deployments, pull request validation, and workflow post-processing. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]
• The workflow now explicitly verifies that the AL-Go for GitHub repository itself only runs on github.com, preventing unsupported usage on GHE for the main repo.
• The gh CLI commands set the GH_HOST environment variable to ensure API calls target the correct host on GHE. [1] [2] [3]

Documentation and user guidance:

• Added a new scenario guide, Scenarios/UsingGitHubEnterprise.md, detailing how to use AL-Go for GitHub on GHE, including setup instructions and best practices.
• The README.md is updated to reference the new GHE usage guide.
• Release notes summarize the GHE compatibility improvements and clarify the support policy.

Other improvements and fixes:

• Improved template repository download logic to construct API URLs correctly for both public GitHub and GHE, and to use authenticated or anonymous requests as appropriate. [1] [2] [3]
• Minor comments and clarifications added to template scripts regarding authentication requirements.

These changes ensure that AL-Go for GitHub works reliably in both public and enterprise GitHub environments, with clear documentation and robust host detection.

This functionality was sponsored by Fellowmind, Sweden.

[freddydk]

@microsoft-github-policy-service agree

[Copilot]

Pull request overview

Enables AL-Go templates and actions to operate on GitHub Enterprise Cloud data-residency hosts.

Changes:

• Replaces hardcoded GitHub URLs with runtime server/API URLs.
• Updates release uploads, dependency retrieval, and template downloads for enterprise hosts.
• Adds enterprise documentation, release notes, safeguards, and regression fixes.

Reviewed changes

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

Show a summary per file

File	Description
Tests/DownloadProjectDependencies.Test.ps1	Tests URL secrets.
Tests/Deploy.Module.Test.ps1	Configures API URL in tests.
Templates/Per Tenant Extension/.github/workflows/CreateRelease.yaml	Makes release operations host-aware.
Templates/Per Tenant Extension/.AL-Go/localDevEnv.ps1	Clarifies GitHub CLI authentication.
Templates/AppSource App/.github/workflows/CreateRelease.yaml	Makes release operations host-aware.
Templates/AppSource App/.AL-Go/localDevEnv.ps1	Clarifies GitHub CLI authentication.
Scenarios/UsingGitHubEnterprise.md	Adds enterprise setup guidance.
RELEASENOTES.md	Announces enterprise compatibility.
README.md	Links the enterprise guide.
Actions/WorkflowPostProcess/WorkflowPostProcess.ps1	Targets the active GitHub CLI host.
Actions/VerifyPRChanges/VerifyPRChanges.ps1	Uses the runtime API URL.
Actions/PullRequestStatusCheck/PullRequestStatusCheck.ps1	Targets the runtime GitHub host.
Actions/Github-Helper.psm1	Derives dependency API hosts.
Actions/GetArtifactsForDeployment/GetArtifactsForDeployment.psm1	Uses host-aware API and run URLs.
Actions/GetArtifactsForDeployment/GetArtifactsForDeployment.ps1	Produces host-aware links.
Actions/DownloadProjectDependencies/DownloadProjectDependencies.psm1	Resolves whole-URL secrets.
Actions/DetermineProjectsToBuild/DetermineProjectsToBuild.psm1	Initializes empty project metadata.
Actions/DetermineProjectsToBuild/DetermineProjectsToBuild.Action.ps1	Emits host-aware build links.
Actions/Deploy/Deploy.psm1	Uses the runtime API URL.
Actions/Deliver/Deliver.ps1	Handles package lookup failures.
Actions/CheckForUpdates/CheckForUpdates.ps1	Configures the GitHub CLI host.
Actions/CheckForUpdates/CheckForUpdates.HelperFunctions.ps1	Adds host-aware template downloads.
Actions/AL-Go-Helper.ps1	Updates defaults and dependency URLs.
.github/workflows/CI.yaml	Restricts AL-Go development CI to GitHub.com.

[freddydk]

Until merged

[Copilot]

Pull request overview

Copilot reviewed 24 out of 24 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (6)

Actions/Deliver/Deliver.ps1:273

• Find-BcNuGetPackage already returns an empty result when no exact package exists. Catching every exception here also converts authentication, configuration, and feed-outage failures into “package missing,” after which the action attempts a push. That can publish after an inconclusive existence check and hides the original failure. Let unexpected lookup errors propagate.

                        try {
                            $feed, $packageId, $packageVersion = Find-BcNugetPackage -nuGetServerUrl $nuGetServerUrl -nuGetToken $nuGetToken -packageName $packageName -version $searchVersion -select Exact -allowPrerelease
                        }
                        catch {
                            $feed = $null
                        }

Scenarios/UsingGitHubEnterprise.md:30

• The documented authentication host differs from the data-residency destination (<enterprise>.ghe.com) used in step 4. Following these commands authenticates GitHub CLI to github.mycompany.com, so credentials will not be available for the actual destination. Use one consistent data-residency hostname throughout the example.

Replace `OWNER/REPO` with the public template (for example `microsoft/AL-Go-PTE` or `microsoft/AL-Go-AppSource`), and `ORG/REPO` and `github.mycompany.com` with your enterprise organization, repository name and host:

```pwsh
# 1. Authenticate to your enterprise host (if not already)
gh auth login --hostname github.mycompany.com

Scenarios/UsingGitHubEnterprise.md:36

• GH_HOST must match the <enterprise>.ghe.com host used by the subsequent mirror push. As written, gh repo create targets a different host from the repository receiving the push.

$env:GH_HOST = "github.mycompany.com"

Scenarios/UsingGitHubEnterprise.md:87

• These commands seed the recommended enterprise templates from Freddy-DK/*, contradicting the official microsoft/AL-Go-PTE and microsoft/AL-Go-AppSource sources identified above and used in the automated example. Users following this section would copy different repositories than the guide promises.

algoctl createrepo --repo https://<enterprise>.ghe.com/<org>/<enterprise>-PTE --templaterepo Freddy-DK/AL-Go-PTE
algoctl createrepo --repo https://<enterprise>.ghe.com/<org>/<enterprise>-AppSource --templaterepo Freddy-DK/AL-Go-AppSource

Actions/CheckForUpdates/CheckForUpdates.HelperFunctions.ps1:101

• This bypasses the repository's InvokeWebRequest wrapper, which handles rate-limit resets, moved repositories, and authentication fallback (Actions/Github-Helper.psm1:57-123). Consequently, Update AL-Go System Files now fails immediately in those cases only when resolving the latest template SHA. Keep using the wrapper with the dynamically constructed URL.

        $url = "$apiUrl/branches/$branch"
        Write-Host "Api URL: $url"
        $result = Invoke-WebRequest -UseBasicParsing -Headers $headers -Uri $url
        $branchInfo = $result.Content | ConvertFrom-Json

Actions/CheckForUpdates/CheckForUpdates.HelperFunctions.ps1:29

• The new host-dependent API URL and authentication branches are not covered by the existing CheckForUpdates Pester suite. Add unit tests for a public github.com template from a GHE workflow and a same-host <enterprise>.ghe.com template, asserting the API URL and whether authentication is applied; these are the core compatibility paths introduced by this PR.

    if ($templateUrl -like 'https://github.com/*') {
        # templateUrl is github.com - use the github.com API URL
        $apiUrl = $templateUrl.Split('@')[0] -replace "^($([regex]::Escape('https://github.com') -replace '/', '\/'))/(.*)$", "https://api.github.com/repos/`$2"
    }
    else {

[Copilot]

Pull request overview

Copilot reviewed 23 out of 23 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (2)

Actions/CheckForUpdates/CheckForUpdates.HelperFunctions.ps1:100

• Calling the raw cmdlet here bypasses the repository's InvokeWebRequest wrapper, which handles rate-limit resets, moved repositories, and retrying public resources without invalid authentication. This is especially relevant now that GHE workflows fetch public GitHub templates anonymously and can hit the low unauthenticated rate limit.

        $result = Invoke-WebRequest -UseBasicParsing -Headers $headers -Uri $url

Scenarios/UsingGitHubEnterprise.md:102

• Use the verb phrase “set up” here; “setup” is a noun or adjective.

If you used the automated approach and specified your indirect template as your template repo, the indirect template is already setup as your template repository.

[microsoft-github-policy-service]

@freddydk please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

[Copilot]

Pull request overview

Copilot reviewed 23 out of 23 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (2)

Actions/Github-Helper.psm1:208

• The existing GetDependencies test only covers release_status = 'thisBuild', so it never executes this new host-derived API path. Add Pester cases for github.com and *.ghe.com dependencies that assert token acquisition and artifact/release requests receive the expected API URL; this is the core compatibility behavior introduced here.

                $token = GetAccessToken -token $dependency.authTokenSecret -api_url $dependencyApiUrl -repository $repository -permissions @{"contents"="read";"actions"="read";"metadata"="read"}
                $artifacts = GetArtifacts -token $token -api_url $dependencyApiUrl -repository $repository -mask $currentMask -projects $projects -version $dependency.version -branch $dependency.branch -baselineWorkflowID $dependency.baselineWorkflowID

Actions/CheckForUpdates/CheckForUpdates.HelperFunctions.ps1:31

• Tests/CheckForUpdates.Action.Test.ps1 does not invoke DownloadTemplateRepository, leaving both new URL branches untested. Add Pester coverage that verifies public github.com templates use api.github.com, same-host GHE templates use GITHUB_API_URL, and cross-host public downloads remain anonymous.

    else {
        # templateUrl is not github.com (e.g. github enterprise) - use the GITHUB_SERVER_URL and GITHUB_API_URL environment variables
        $apiUrl = $templateUrl.Split('@')[0] -replace "^($([regex]::Escape($env:GITHUB_SERVER_URL) -replace '/', '\/'))/(.*)$", "$ENV:GITHUB_API_URL/repos/`$2"