Repository navigation
Reusable action readers get direct behavior descriptions - #569
Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Open
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Marius Storhaug (MariusStorhaug) wants to merge 3 commits into
Conversation
Open
7 tasks done
Contributor
There was a problem hiding this comment.
🟢 Approved
No active review issues are recorded for the documentation-only wording clarifications.
No open issues 🎉
What changed in this PR
This documentation-only PR makes three reusable PSModule action references more direct, naming the actors and clarifying behavior without changing runtime code or caller requirements.
Changes:
- Clarifies test-result collection, logging, and failure descriptions.
- Simplifies coverage reporting, threshold, and summary-selection guidance.
- Removes promotional installer wording while preserving examples, links, and input settings.
| File | Description |
|---|---|
.github/actions/Install-PSModule/README.md |
Simplifies setup, output, and example descriptions. |
.github/actions/Get-PesterTestResults/README.md |
Uses direct wording for artifact processing, logging, and failures. |
.github/actions/Get-PesterCodeCoverage/README.md |
Clarifies coverage reporting, target selection, and summary controls. |
Review effort: Balanced
4 tasks
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
November 4, 2026 14:43
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reusable action readers get direct descriptions of test results, coverage thresholds, and setup guidance. Three READMEs use present-tense statements and name the actor for each result. The prose edits require no caller changes.
Changed: Reusable action guidance names each actor
The Pester-result reference states what the action collects, writes, and treats as a failure. The coverage reference states how the action uses the target and summary-selection input. The installer reference uses neutral setup prose instead of promotion. The workflow recommendation remains advisory.
Input settings, output and artifact names, commands, complete examples, version references, and failure semantics stay unchanged. Four short site-action references need no edit. Existing source-contract gaps remain explicit exceptions in the open follow-up; this PR does not certify or repair them.
Technical details
Delivery and immutable scope
This draft opens after the first coherent commit. It stays draft; merge, auto-merge, and Agent merge are excluded.
PSModule/Process-PSModule64ffb1d87f86bd5d487891fdb140b78385a005312742b3da509fbdd67caf5c5c5d2c19a8959dd89911e54fa38bb4a2aae57140ed6c55efecfa4f8726- test-result prosecb48ff8308ddb46d98eb3527f0e4dbc4289b705c- coverage prose2742b3da509fbdd67caf5c5c5d2c19a8959dd899- neutral installer prosegit diff 64ffb1d87f86bd5d487891fdb140b78385a00531 2742b3da509fbdd67caf5c5c5d2c19a8959dd899The remote branch and GitHub report the same final head. The worktree is clean. This is scoped prose-only evidence, not a release-bound coverage record. Release labels, publication behavior, and configuration remain unchanged.
Reviewed paths
All paths below are under
.github/actions/. Every README has a full manual review against its localaction.ymland entry script. The coverage helper, site helper scripts, Pester caller workflows, and pinned GitHub-Script bootstrap supply related evidence.Get-PesterTestResults/README.mdLatestdefault and standalone example remain exceptions, not accuracy passesGet-PesterCodeCoverage/README.mdLatestdefault, and standalone example remain exceptions, not accuracy passesInstall-PSModule/README.mdHelpers/PSModule, copied version, and both examples remain exceptions, not accuracy passesBuild-ZensicalSite/README.mdInject-SiteScripts/README.mdInstall-Zensical/README.mdpip install zensical; metadata defines no inputsStructure-Site/README.mdAll four no-change files retain their baseline Git blob identities. No new reference layout or template scaffolding is added.
Exact before/after evidence
A GitHub Action that gathers Pester test results for the PSModule process by analyzing test artifacts from the workflow run.This GitHub Action collects Pester test results from workflow artifacts for the PSModule process.It validates test execution and results, providing a summary and failing if any tests are unsuccessful.The action examines test execution and results. It writes a summary and fails if tests do not pass.It is recommended to use the [Process-PSModule workflow](https://github.com/PSModule/Process-PSModule) to automate the whole process of managing the PowerShell module.For the recommended setup, use the [Process-PSModule workflow](https://github.com/PSModule/Process-PSModule) to automate PowerShell module management.Detailed results are logged in the workflow run's output.The action writes detailed results to the workflow run log.If any tests fail or errors occur, the action exits with a non-zero code, marking the workflow step as failed.If tests fail or errors occur, the action exits with a nonzero code. GitHub Actions marks the workflow step as failed.Fails the workflow if coverage falls below specified targets.If coverage is below the specified target, the action fails the workflow.Enable debugging by setting inputs:To get debug and verbose output, set these inputs:Here's a complete workflow example demonstrating how to use the Install-PSModule action:This example shows the action in a workflow:The test-result behavior matches artifact collection, result/failure evaluation, and summary/exit handling. Coverage target selection matches lines 123-131; failure below target matches lines 389-397.
Retained factual exceptions
#572 is the open owning-repository Task for each exception below. Existing action-folder and action-repository issues were checked before it was filed; they do not own these repairs.
Helpersand a latest copy; local source installs bundledPSModuleat999.0.0. All three behavior bullets and both fenced examples remain unchanged.gh run download; local source delegates to PowerShell artifact functions. A transitive CLI requirement is not established by this local script. The exact requirement and command remain unchanged.id; pinned GitHub-Script metadata exposes onlyresult. The script writes the value to the inner step'sGITHUB_OUTPUT. The outer output is not established; neither metadata nor the documented output is changed here.VersiondefaultsLatest. The pinned bootstrap can reuse an installed GitHub module when no version is set. An unconditional latest-version guarantee is not established for that environment.Get-PesterCodeCoverage/README.mdcallsPSModule/Get-PesterCodeCoverage@v1; the framework caller uses./_wf/.github/actions/Get-PesterCodeCoverage. The targets differ. The exact example remains unchanged; source equivalence is not established.Get-PesterTestResults/README.mdcallsPSModule/Get-PesterTestResults@v1; the framework caller uses./_wf/.github/actions/Get-PesterTestResults. The targets differ. The exact example remains unchanged; source equivalence is not established.PSModule/Install-PSModule@v1; the local composite runs its bundled script. The full example queriesHelpers, while local source installsPSModule. Both examples remain unchanged; source equivalence is not established.These are not acceptance passes for factual accuracy. No live workflow reproduction is claimed for the output-route defect. No contract, runtime, lifecycle metadata, version policy, or example-target repair is included in this writing PR.
Validation
The existing Markdown configuration runs on all seven owned files:
Both commands exit
0. Markdownlint checks seven files and reports zero issues. It usesmarkdownlint-cli2 v0.24.0andmarkdownlint v0.42.0. The same check passes before edits and on each changed file. No dependency is installed.Native PowerShell comparisons against
git show <base>:<path>verify all 11 complete fenced examples, including the indentedStepSummary_ModeYAML block. They match after CRLF/LF normalization. The final fence matcher includes up to three leading spaces and matching closing indentation; this corrects the earlier column-zero-only count.The comparisons also verify unchanged headings apart from case, all six prose-link URLs, inline code identifiers, input name/required/default cells, the three conflicting installer bullets, and the deferred CLI requirement. The four no-change READMEs have identical Git blob hashes. Nine targeted wording checks fail on the original prose and pass after the edit. These preservation passes do not certify the retained contract claims.
No dedicated documentation link checker exists in this checkout. Markdownlint checks same-file fragments. Both unchanged unique prose-link targets return HTTP
200fromInvoke-WebRequest -Method Head. Heading capitalization changes preserve their slugs. No cross-owner anchor or link repair is needed.A native Copilot review was explicitly requested. Review
5768356776isAPPROVEDat the final head and has no inline comments. The review does not resolve or override the factual exceptions. At final inspection, all reported GitHub checks are complete withSUCCESSorSKIPPED; none reports failure. This includes the repository linter and both default/manifest workflow test runs.Standards and framework alignment
The fixed writing source is
MSXOrg/docs@1b0d4893c8fefabe604d04393068a8ff6f848082, not a moving branch. The review reads Documentation Model, Natural Language, Writing Guide, Markdown, Documentation, and the reference/guide templates. Pinned Task, PR Format, and commit conventions govern the delivery evidence.The review also reads the official STE description, FAQ, and relevant rules and dictionary entries in Issue 9. The local read-only PDF matches the publisher's MD5,
9c720341c350ed77943b2c73d01c716f. All required sources are available. No manual content is republished. No automated scan proves full STE conformance..github/actions/Get-PesterTestResults/README.md.github/actions/Get-PesterCodeCoverage/README.md.github/actions/Install-PSModule/README.mdPlan, ownership, and exclusions
The delivery issue's test-first plan records expected wording properties and baseline failures before edits, full source review, small commits, the early draft, final preservation checks, and retained factual exceptions. The writing steps are complete. The open follow-up owns the contract work.
Open PR ownership is checked before each commit. No other PR changes an assigned README. Direct inspection confirms that #551 changes no README or action metadata. The scoped issue-convergence sweep checks open README/action issues, the seven action names, the documentation-writing-alignment family, and #442 and #360. Only #557 is satisfied by this writing diff. The follow-up and sibling issues remain open.
Excluded paths are all other README files;
.github/actions/**/action.yml; action runtime source and native help under.github/actions/**/src/**; tests;docs/**;.github/plugin/**;.github/workflows/**; site configuration and generated output. Publish, Release, Resolve, and Cleanup action docs belong to existing release/recovery PRs and are excluded in full. No new linter, dependency, generated file, site design, or framework behavior is added.Related references