Provide package cache to aldoc when building reference documentation#2301
Open
spetersenms wants to merge 7 commits into
Open
Provide package cache to aldoc when building reference documentation#2301spetersenms wants to merge 7 commits into
spetersenms wants to merge 7 commits into
Conversation
aldoc build was invoked with only --source, so it fell back to its default
package cache ({source}/.alpackages) which does not exist for artifact-based
apps. As a result every reference to another module was reported as
'Referenced module not loaded' and the corresponding links in the generated
documentation were left unresolved.
Populate a package cache with all apps and their dependencies (the latter were
already downloaded and computed by CalculateProjectsAndApps but never used) and
pass it to aldoc via --packagecache so cross-module references resolve.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes cross-module reference resolution in AL-Go's generated reference documentation. Previously aldoc build was called with only --source, so it fell back to its default (non-existent for artifact-based apps) .alpackages cache and reported every cross-module reference as "Referenced module not loaded", leaving documentation links unresolved. The change populates a dedicated ALDoc package cache with the target apps and their dependencies (already computed by CalculateProjectsAndApps but previously unused) and passes it via --packagecache.
Changes:
- Added an optional
-allDependenciesparameter toGenerateDocsSiteand a temporary package-cache folder that is populated with target apps + dependency apps and cleaned up infinally. - Passed
--packagecacheto thealdoc buildinvocation so cross-module references resolve. - Wired the existing
$allDependenciesreturn value fromCalculateProjectsAndAppsinto bothGenerateDocsSitecall sites (release loop and main/current branch).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| Actions/BuildReferenceDocumentation/BuildReferenceDocumentation.ps1 | Passes -allDependencies to GenerateDocsSite for both the release and main documentation paths. |
| Actions/BuildReferenceDocumentation/BuildReferenceDocumentation.HelperFunctions.ps1 | Adds -allDependencies parameter, builds and cleans up a package cache from apps + dependencies, and supplies --packagecache to aldoc build. |
Covers the new behavior: apps and their dependencies are copied into a package cache and aldoc build is invoked with --packagecache. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This reverts commit 4820ec0.
aholstrup1
reviewed
Jul 8, 2026
aholstrup1
left a comment
aholstrup1
left a comment
Collaborator
There was a problem hiding this comment.
Releasenote needs to be updated but otherwise looks fine
| - Issue 2235 - Workspace compilation: only the first `customCodeCops` entry resolved when multiple relative paths were configured. Relative `customCodeCops` paths are now resolved against the project folder before being passed to the compiler. | ||
| - Issue 2265 - Creating a Performance Test App fails on Linux due to case-sensitive path lookup for the Performance Toolkit sample app | ||
| - Issue 2284 - GitHub App authentication fails with `401 (Unauthorized)` on runners with minor clock drift. The JWT `iat` claim is now backdated by 60 seconds instead of 10, as recommended by GitHub, to tolerate runners whose clock runs slightly ahead of GitHub. | ||
| - Issue 2302 - AlDoc does not use --packagecache when building reference documentation |
Collaborator
There was a problem hiding this comment.
Need to be updated now that we shipped 9.1
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
aldoc build was invoked with only --source, so it fell back to its default package cache ({source}/.alpackages) which does not exist for artifact-based apps. As a result every reference to another module was reported as 'Referenced module not loaded' and the corresponding links in the generated documentation were left unresolved.
Populate a package cache with all apps and their dependencies (the latter were already downloaded and computed by CalculateProjectsAndApps but never used) and pass it to aldoc via --packagecache so cross-module references resolve.
Fixes #2302
✅ Checklist