Skip to content

📖 [Docs]: Release branch workflow is documented - #454

Draft
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
mainfrom
document-release-branch-policy
Draft

📖 [Docs]: Release branch workflow is documented#454
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
mainfrom
document-release-branch-policy

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

The release branch workflow is now documented for batching independent features into one stable release while preserving the framework's default-branch publication gate.

New: Release branch workflow guidance

The versioning guide now explains how to:

  • configure the caller workflow to run for main and release/** pull requests;
  • cut a release branch and draft promotion PR;
  • target independent feature PRs at the release branch;
  • use Prerelease previews on non-default branches; and
  • promote the completed release branch into main for the stable release.

The guidance follows the MSX PR Format: feature PRs close their own scoped issues, while the aggregate release PR summarizes and links the included work without duplicating issue closures.


Technical details
  • Added the release branch pattern to docs/content/guides/versioning-and-releases.md.
  • Matched the documented behavior to Get-PSModuleSettings: stable publication occurs only for merged pull requests targeting the repository default branch; Prerelease is available for open pull requests with important changes.
  • Kept the pattern in the existing versioning guide rather than adding a duplicate page.
Relevant issues (or links)
  • PSModule/docs#90

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 Aug 9, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
CSS Pass ✅
CSS_PRETTIER 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

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