Skip to content

📚 docs(release): require dev promotion before tags - #469

Merged
seakee merged 2 commits into
devfrom
docs/release-dev-promotion
Aug 1, 2026
Merged

📚 docs(release): require dev promotion before tags#469
seakee merged 2 commits into
devfrom
docs/release-dev-promotion

Conversation

@seakee

@seakee seakee commented Aug 1, 2026

Copy link
Copy Markdown
Owner

Summary

Document the protected release path so release preparation enters dev, is promoted through dev → main, and is tagged only from the verified stable merge. The repo-local $release skill now enforces the same sequence.

Scope

  • Frontend panel
  • Manager Server
  • CPA panel mode
  • Full Docker mode
  • Native packages / release
  • Docs / Wiki
  • CI / build / tooling

Changes

  • Define release/<version> → dev → main → tag as the mandatory release branch flow.
  • Require a frozen, recorded dev SHA between the merged release PR and the promotion PR.
  • Explain the protected-branch merge topology and stop condition for release-scope drift.

User Impact

Release preparation now has an explicit, reproducible integration and promotion gate before a tag can publish packages or a GitHub Release.

Compatibility / Runtime Notes

  • CPA panel mode: N/A.
  • Manager Server mode: N/A.
  • Full Docker / native packages: No runtime or packaging behavior changes; the release procedure is clarified.

Data / Security Notes

No credentials, runtime configuration, database data, or release secrets are changed. The documented source gate uses the existing same-repository dev → main policy.

Risk / Rollback

Risk level: Low

Rollback notes:

Revert this documentation commit and restore the previous release procedure if the branch model changes.

Verification

  • Type check
  • Lint
  • Tests
  • Build
  • Manual UI check
  • Docs/link check
  • Not applicable, docs-only

Commands / evidence:

git diff --check
git rev-list --no-merges origin/dev..origin/main  # no output
git merge-base --is-ancestor origin/dev origin/main  # success

Screenshots / Recordings

N/A — release-process documentation only.

Docs

  • README / README_CN updated for user-visible capabilities
  • Matching docs manual and navigation updated
  • Demo fixtures, screenshots, and deep links reviewed
  • Release notes needed
  • Not needed — this governs the release workflow itself and does not change a product capability.

Docs decision:

docs/release.md is the canonical repository release-process reference.

Related

Refs #468

Route release preparation through dev before it can reach the stable main branch.\nRecord and freeze the release dev SHA to prevent unrelated commits entering a tag.\nDocument the promotion gate and the merge-commit topology used by the protected branches.
@seakee seakee mentioned this pull request Aug 1, 2026
19 tasks
@seakee
seakee merged commit 00c26e0 into dev Aug 1, 2026
8 checks passed
@seakee seakee mentioned this pull request Aug 1, 2026
19 tasks
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