📖 [Docs]: Test standards and release branch pattern documented#90
Open
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Open
📖 [Docs]: Test standards and release branch pattern documented#90Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Conversation
…mmands Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
… release Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
July 26, 2026 10:40
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.
Two process gaps found while building the Toml module are now documented as canonical process.
New: Release Branch Pattern
A new page (Process-PSModule/release-branch-pattern.md) documents how to batch several independent feature PRs into one release: cut a release branch from
main, open a draft release PR targetingmain, cut feature branches from the release branch with feature PRs targeting it, then un-draft and merge the release PR once every feature has landed. The release PR carries the combinedCloses #Nlist and release notes. This is distinct from Module Bootstrap (first release of a brand-new module) and from a stacked pull request (dependent layers) — both existing docs now cross-link to it.Changed: Test standards clarified
Standards.md § Tests and Test-Specification.md now state plainly that tests run against the built and imported module, never against source — test files (including
tests/BeforeAll.ps1) must not build or import the module themselves. A single consolidatedtests/<ModuleName>.Tests.ps1is called out as the preferred layout, and a local test-running recipe is added: build,Import-Modulethe output artifact, thenInvoke-Pester -Path ./tests/ -CI.Fixed a contradiction: Standards.md previously told contributors to mock module boundaries, while Test-Specification.md already said "no mocks." Standards.md is corrected to match the no-mocks rule, with the external-dependency exception routed to a separate live integration suite instead of a mock.
Technical details
src/docs/Modules/Standards.md: rewrote the## Testssection — built/imported-module requirement, no-mocks rule (removed the conflicting mocking guidance), preferred single-file profile, new### Running tests locallysubsection, and atests/BeforeAll.ps1clarification under### Shared test infrastructure.src/docs/Modules/Test-Specification.md: added an overview cross-link toStandards.md#tests.src/docs/Modules/Process-PSModule/release-branch-pattern.md: new page with pattern steps, mermaid diagram, release-PR body guidance, merge order, and "when to use this."src/docs/Modules/Process-PSModule/index.mdandmodule-bootstrap.md: linked the new page.src/zensical.toml: added the new page to nav.zensical build --clean(no issues).Relevant issues (or links)