Skip to content

📖 [Docs]: Test standards and release branch pattern documented#90

Open
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
mainfrom
test-standards-and-release-pr-docs
Open

📖 [Docs]: Test standards and release branch pattern documented#90
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
mainfrom
test-standards-and-release-pr-docs

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

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 targeting main, 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 combined Closes #N list 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 consolidated tests/<ModuleName>.Tests.ps1 is called out as the preferred layout, and a local test-running recipe is added: build, Import-Module the output artifact, then Invoke-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 ## Tests section — built/imported-module requirement, no-mocks rule (removed the conflicting mocking guidance), preferred single-file profile, new ### Running tests locally subsection, and a tests/BeforeAll.ps1 clarification under ### Shared test infrastructure.
  • src/docs/Modules/Test-Specification.md: added an overview cross-link to Standards.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.md and module-bootstrap.md: linked the new page.
  • src/zensical.toml: added the new page to nav.
  • Verified with zensical build --clean (no issues).
Relevant issues (or links)
  • Requested by PSModule/Toml session (Toml module build), no linked issue.

…mmands

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

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

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV 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

@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 26, 2026 10:40
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