Skip to content

⚙️ [Maintenance]: Public help links follow canonical documentation paths#420

Draft
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
mainfrom
validate-public-help-links
Draft

⚙️ [Maintenance]: Public help links follow canonical documentation paths#420
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
mainfrom
validate-public-help-links

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 26, 2026

Copy link
Copy Markdown
Member

Public module source validation now requires every script under src/functions/public to put its canonical generated-documentation URL first in comment-based help.

Changed: Canonical public help links are enforced

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-SourceCode now forwards the configured module name into the shared test action instead of falling back to the repository name.
  • Uses the module name resolved by Test-PSModule, including configured name overrides.
  • Covers ungrouped and nested public function scripts.
  • Requires at least one .LINK, exact URL casing/content, first-link ordering, and a trailing slash.
  • Adds consuming-module fixtures for both grouped and ungrouped paths.

Validation

  • Focused positive fixture runs pass for both dynamic module names (5 cases each).
  • Focused negative runs confirm missing, non-exact, and non-first links each fail deterministically.
  • Full source-code standards suites pass for both fixtures (14 tests each).
  • PSScriptAnalyzer reports no warnings or errors in changed PowerShell files.
  • Draft PR CI passes, including repository lint, CodeQL, action analysis, and both workflow-test matrices.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Jul 26, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS 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

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant