⚙️ [Maintenance]: Public help links follow canonical documentation paths (#420)
Public module source validation requires each public function-bearing script under src/functions/public to put its canonical generated-documentation URL first in comment-based help.
Changed: Canonical public help links are enforced for function-bearing files
The source-code standards suite derives documentation paths from recursive public function paths and validates the first .LINK against https://psmodule.io/<ModuleName>/Functions/<relative path>/<FunctionName>/.
Technical Details
Test-SourceCodeforwards the configured module name into the shared test action instead of falling back to the repository name.- Public help-link validation applies only to public scripts that define at least one function/filter.
- Covers ungrouped and nested public function scripts.
- Requires at least one
.LINK, exact URL casing/content, first-link ordering, and a trailing slash. - Fixture repos cover both grouped and ungrouped function paths while non-function public scripts are not forced to provide canonical links.
Downstream dependency status (live)
PSModule/DomeneshopPR #17 has already been merged intomainat2ca6f788c4b68a72c63d6472ae19720bc90cc8b9while still pinned toProcess-PSModulev6.1.13 (fb1bdb8fefd243292f779d2a856a38db6fe6daf4).- That downstream state currently lacks the local
PublicHelpLinks/ModuleRequirements/TestLayoutchecks intended by this framework update. - Merging this PR unblocks downstream alignment by making the canonical public help-link validation available in the framework version line.
Validation
- Focused PublicHelpLink runs pass for both dynamic module names (4 cases each after scoping).
- Full source-code standards suites pass for both fixtures (13 tests each).
- PSScriptAnalyzer reports no warnings or errors in changed files.
- Draft PR CI passes, including linter, CodeQL, action analysis, and both workflow-test matrices.