[release/v7.4.15] Add comment-based help documentation to build.psm1 functions#27227
Conversation
daxian-dbw
added
the
CL-BuildPackaging
daxian-dbw
added
the
CL-BuildPackaging
There was a problem hiding this comment.
Pull request overview
Backports comment-based help (CBH) into build.psm1 on release/v7.4.15 to improve maintainability and discoverability of build/test tooling functions.
Changes:
- Added CBH blocks (.SYNOPSIS/.DESCRIPTION/.PARAMETER/.OUTPUTS) across many
build.psm1functions. - Minor cleanup within the test/build helpers (e.g., small logic/typo corrections in the touched areas).
- Removed an older free-form comment in favor of structured CBH for
ConvertFrom-PesterLog.
There was a problem hiding this comment.
The comment-based help for New-PSOptions says the Framework defaults to 'net11.0', but the actual parameter is constrained to net8.0 and defaults to "net8.0". Please update the help text so it matches the real default/framework supported on this branch.
| The target .NET framework moniker. Defaults to 'net11.0'. | |
| The target .NET framework moniker. Defaults to 'net8.0'. |
| .PARAMETER PSModuleRestore | ||
| Whether Gallery modules should be restored to the build output. | ||
| .PARAMETER Framework | ||
| The target .NET framework moniker, e.g. 'net11.0'. |
There was a problem hiding this comment.
The comment-based help for New-PSOptionsObject uses 'net11.0' as the example framework moniker, but this branch/build script is using net8.0 (see New-PSOptions). Please update the example to avoid pointing readers at a framework that isn't used/supported here.
| The target .NET framework moniker, e.g. 'net11.0'. | |
| The target .NET framework moniker, e.g. 'net8.0'. |
There was a problem hiding this comment.
PR description/testing notes say this is a help-text-only backport, but this hunk includes a functional behavior change (arm64 now correctly throws as unsupported). Please update the PR description (or split the functional fix) so reviewers/release managers understand this isn't documentation-only.
Backport of #27122 to release/v7.4.15
Triggered by @daxian-dbw on behalf of @powercode
Original CL Label: CL-BuildPackaging
/cc @PowerShell/powershell-maintainers
Impact
REQUIRED: Choose either Tooling Impact or Customer Impact (or both). At least one checkbox must be selected.
Tooling Impact
Adds comment-based help to build.psm1 functions on release/v7.4.15 so build and release tooling remains documented and easier to maintain.
Customer Impact
Regression
REQUIRED: Check exactly one box.
This is not a regression.
Testing
This backport updates help text only in build.psm1. The cherry-pick applied cleanly to release/v7.4.15 with no code conflicts, and CI on the backport PR will validate that the build module still loads and scripts continue to parse correctly.
Risk
REQUIRED: Check exactly one box.
Low risk because the change is documentation-only in build tooling and does not alter shipped runtime behavior.