You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Enable AL-Go for GitHub on GitHub Enterprise Cloud with data residency - #2407
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.
Please retain the rate-limit-aware InvokeWebRequest wrapper here. Enterprise workflows now download public templates anonymously, using GitHub's 60-requests/hour quota. In the action's default Windows PowerShell shell, this direct call bypasses the wrapper's 403/reset recovery (Github-Helper.psm1:92–103), so quota exhaustion fails the template update instead of waiting and retrying. The wrapper already supplies UseBasicParsing.
The reason will be displayed to describe this comment to others. Learn more.
🔵 Needs a closer look
Cross-host authentication and release uploads need enterprise integration validation, alongside the requested regression coverage and settings documentation.
No open issues 🎉
3 previously missed issues
In code that hasn't changed since last review
Document appDependencyProbingPaths host and authentication rules
Actions/AL-Go-Helper.ps1:968
Document the new appDependencyProbingPaths host rules in Scenarios/settings.md and Actions/.Modules/settings.schema.json. The settings table still lists latestBuild without this same-host restriction, while the schema only links to that table. A GHE repository configured to consume a public GitHub latestBuild dependency now fails here. Explain that latestBuild requires the current host, owner/repo shorthand resolves against that host, and cross-host dependencies must use an explicit URL and a supported release status such as release or prerelease, with suitable access credentials when required.
Add template host and authentication routing tests
Add mocked Pester coverage for these template host/authentication branches in Tests/CheckForUpdates.Action.Test.ps1, which already tests other functions in this helper. Cover a public GitHub template on github.com, a same-host GHE template whose initial request fails and requires the fallback token, and a GHE repository downloading Microsoft's public template. Assert the branch/archive API URLs and which requests carry Authorization, including anonymous access for the cross-host public template. The current tests do not verify this routing or credential selection.
Add regression tests for dependency host selection
Actions/Github-Helper.psm1:208
Add regression tests for dependency-host selection in Tests/GitHub-Helper.Test.ps1. The existing GetDependencies test exercises only thisBuild, and the new helper tests receive an already-computed API URL, so neither covers this routing. Test github.com and tenant.ghe.com dependencies with a different GITHUB_API_URL, and mock authentication and downloads to assert that the derived API URL reaches GetAccessToken, GetArtifacts, GetReleases, and DownloadRelease in the applicable latestBuild and release cases.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
❔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.comandapi.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:
GITHUB_SERVER_URLandGITHUB_API_URLenvironment variables instead of hardcodedgithub.comandapi.github.comURLs 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]github.com, preventing unsupported usage on GHE for the main repo.ghCLI commands set theGH_HOSTenvironment variable to ensure API calls target the correct host on GHE. [1] [2] [3]Documentation and user guidance:
Scenarios/UsingGitHubEnterprise.md, detailing how to use AL-Go for GitHub on GHE, including setup instructions and best practices.README.mdis updated to reference the new GHE usage guide.Other improvements and fixes:
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.