⚙️ [Maintenance]: Public help-link checks now support any HTTPS host

[Marius Storhaug (MariusStorhaug)]

Public command help-link validation now works with any HTTPS documentation host while preserving the required module and function path structure. Repositories can publish their command reference outside the PSModule documentation site without weakening the canonical URL contract.

Changed: Public help-link validation

Every public function must provide a first .LINK entry. The test fails immediately when no .LINK section is found. When a link is present, it must be an absolute HTTPS URL with a host and the canonical /Module/Functions/<relative-command>/ path; query strings and fragments are rejected.

The PowerShell module standard, framework-test reference, pre-review validation checklist, module-structuring guide, and skip-test guide now document this requirement using a configurable HTTPS documentation host.

---

Technical details

• Changed .github/actions/Test-PSModule/src/tests/SourceCode/PSModule/PSModule.Tests.ps1 to require a link, then parse the first .LINK URI and validate its scheme, host, path, query, and fragment instead of comparing against a hardcoded psmodule.io origin.
• Updated one grouped command fixture in each test repository to use https://docs.example.com, proving the test does not depend on the PSModule host.
• Documented PublicHelpLink in docs/content/reference/powershell-module-standard.md and docs/content/reference/framework-test-ids.md.
• Added the requirement to docs/content/guides/validating-before-review.md and replaced fixed-host examples in the structuring and skip-test guides with <DocumentationHost>.
• Validation: the targeted Pester 6.1.0 source-code suite passed 13 tests for both tests/srcTestRepo and tests/srcWithManifestTestRepo; zensical build --strict and git diff --check passed.

Changed surface	Standards checked	Framework docs checked	Result
.github/actions/Test-PSModule/** (PowerShell)	MSX PowerShell standard	Public command help-link contract	Aligned
tests/** (PowerShell fixtures)	MSX PowerShell standard	Source-code test fixtures	Aligned
docs/content/reference/** and docs/content/guides/** (Markdown)	MSX Documentation Model, Markdown	Module layout and framework-test guidance	Aligned

Issue convergence sweep: scoped to reusable public help-link validation and its contributor guidance. This change does not generate missing links during scaffolding or build, so the broader follow-up remains open.

Relevant issues (or links)

Related work

• References PublicHelpLink test enforces canonical .LINK but framework does not generate it #445
• References 📖 [Docs]: Module layout guidance now covers grouped help URLs #453

[github-actions]

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
CSS	Pass ✅
CSS_PRETTIER	Pass ✅
GITHUB_ACTIONS	Pass ✅
GITHUB_ACTIONS_ZIZMOR	Pass ✅
GITLEAKS	Pass ✅
GIT_MERGE_CONFLICT_MARKERS	Pass ✅
HTML	Pass ✅
JAVASCRIPT_ES	Pass ✅
JAVASCRIPT_PRETTIER	Pass ✅
MARKDOWN	Pass ✅
NATURAL_LANGUAGE	Pass ✅
POWERSHELL	Pass ✅
PRE_COMMIT	Pass ✅
SPELL_CODESPELL	Pass ✅
TRIVY	Pass ✅
YAML	Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter