Skip to content

Fix ALDoc missing symbols and XML documentation by including dependencies #1824

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
+34 −3
Draft

Fix ALDoc missing symbols and XML documentation by including dependencies #1824

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0a72327
Initial plan
Copilot Jul 10, 2025
c00c0d3
Fix ALDoc missing symbols by including dependencies in build process
Copilot Jul 10, 2025
a9e0737
Update BuildReferenceDocumentation.HelperFunctions.ps1
mazhelez Jul 15, 2025
a4c376d
Merge branch 'main' into copilot/fix-883
mazhelez Jul 15, 2025
55744d5
Use custom BCContainerHelper
mazhelez Jul 16, 2025
ebe8086
Include deplendencies using --packagecache
mazhelez Jul 16, 2025
30ab0ee
--packageCache --> --packagecache
mazhelez Jul 16, 2025
363a533
Add debug logs
mazhelez Jul 16, 2025
bbf8334
Download dependencies artifact when generating reference documentation
mazhelez Jul 16, 2025
4550c82
Merge branch 'main' into copilot/fix-883
mazhelez Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Actions/BuildReferenceDocumentation/BuildReferenceDocumentation.HelperFunctions.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ function GenerateDocsSite {
[string] $version,
[string[]] $allVersions,
[hashtable] $allApps,
[hashtable] $allDependencies,
[string] $repoName,
[string] $releaseNotes,
[string] $header,
Expand Down Expand Up @@ -195,6 +196,14 @@ function GenerateDocsSite {
foreach($value in $allApps.Values) {
$apps += @($value)
}

# Include dependencies for ALDoc to resolve symbols correctly
if ($allDependencies) {
foreach($value in $allDependencies.Values) {
$apps += @($value)
}
}

$apps = @($apps | Select-Object -Unique)

$arguments = $aldocArguments + @(
Expand Down
4 changes: 2 additions & 2 deletions Actions/BuildReferenceDocumentation/BuildReferenceDocumentation.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ foreach($release in $releases) {
$allApps, $allDependencies = CalculateProjectsAndApps -tempFolder $tempFolder -includeProjects $includeProjects -excludeProjects $excludeProjects -groupByProject:$settings.alDoc.groupByProject
$version = $release.Name
$releaseNotes = $release.body
GenerateDocsSite -version $version -allVersions $versions -allApps $allApps -repoName $settings.repoName -releaseNotes $releaseNotes -header $header -footer $footer -defaultIndexMD $defaultIndexMD -defaultReleaseMD $defaultReleaseMD -docsPath $docsPath -logLevel $logLevel -groupByProject:$settings.alDoc.groupByProject
GenerateDocsSite -version $version -allVersions $versions -allApps $allApps -allDependencies $allDependencies -repoName $settings.repoName -releaseNotes $releaseNotes -header $header -footer $footer -defaultIndexMD $defaultIndexMD -defaultReleaseMD $defaultReleaseMD -docsPath $docsPath -logLevel $logLevel -groupByProject:$settings.alDoc.groupByProject
do {
try {
$retry = $false
Expand Down Expand Up @@ -107,7 +107,7 @@ if ($latestReleaseTag) {
else {
$releaseNotes = ''
}
GenerateDocsSite -version '' -allVersions $versions -allApps $allApps -repoName $settings.repoName -releaseNotes $releaseNotes -header $header -footer $footer -defaultIndexMD $defaultIndexMD -defaultReleaseMD $defaultReleaseMD -docsPath $docsPath -logLevel $logLevel -groupByProject:$settings.alDoc.groupByProject
GenerateDocsSite -version '' -allVersions $versions -allApps $allApps -allDependencies $allDependencies -repoName $settings.repoName -releaseNotes $releaseNotes -header $header -footer $footer -defaultIndexMD $defaultIndexMD -defaultReleaseMD $defaultReleaseMD -docsPath $docsPath -logLevel $logLevel -groupByProject:$settings.alDoc.groupByProject

Write-Host "::endgroup::"

Expand Down
Loading