Skip to content

📖 [Docs]: Module bootstrap branching pattern documented#89

Merged
Marius Storhaug (MariusStorhaug) merged 6 commits into
mainfrom
module-bootstrap-branch-doc
Jul 26, 2026
Merged

📖 [Docs]: Module bootstrap branching pattern documented#89
Marius Storhaug (MariusStorhaug) merged 6 commits into
mainfrom
module-bootstrap-branch-doc

Conversation

@MariusStorhaug

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

Copy link
Copy Markdown
Member

Modules that need several interdependent functions before a first release is usable now have a documented pattern to follow, instead of improvising it per repo.

New: Module Bootstrap page

src/docs/Modules/Process-PSModule/module-bootstrap.md documents the pattern: identify the module's load-bearing core first (the conversion pivot for data modules, or the Context-backed credential store + client + first API function for integration modules, per the existing Module types archetypes), scope one long-lived integration branch to exactly that core, and open small focused PRs targeting that branch in parallel until it's coherent. Merging the integration branch into main becomes the module's v1.0.0. After that, ordinary SemVer applies — new functions on the stable core are minor/patch bumps unless they break the core's own contract. Follow-up feature PRs can keep targeting the integration branch before it merges.

The page is linked from the Process-PSModule nav/index and cross-referenced from template-quickstart.md for modules that need this before the ordinary single-command quickstart applies.

Technical Details

  • Added src/docs/Modules/Process-PSModule/module-bootstrap.md, cross-linking Module-Types.md and Versioning.md.
  • Registered it in src/zensical.toml nav and Process-PSModule/index.md.
  • Added a one-line cross-reference from template-quickstart.md.
  • No MSXOrg/docs changes: the existing "Stacked pull requests" / "Merge models" sections in Branching-and-Merging.md already cover the general framework; this page is a PSModule-specific application of it and links out for contrast rather than duplicating that content.

Docs-only change, no issue required.

$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 ✅
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

$Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
$Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
$Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
$Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 26, 2026 09:13
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit 0b4b9e8 into main Jul 26, 2026
21 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the module-bootstrap-branch-doc branch July 26, 2026 09:13
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