Skip to content

📝 add release workflow docs and cut-release.sh#4440

Draft
guiyanakuang wants to merge 1 commit into
mainfrom
docs/issue-4439-release-workflow
Draft

📝 add release workflow docs and cut-release.sh#4440
guiyanakuang wants to merge 1 commit into
mainfrom
docs/issue-4439-release-workflow

Conversation

@guiyanakuang

Copy link
Copy Markdown
Member

Closes #4439.

This is Phase 1 of the release workflow rework tracked in #4439: docs
and helper script only. CI is unchanged in this PR.

What's added

  • doc/en/Releasing.md + doc/zh/Releasing.md — full release workflow doc:
    branch model, tag scheme, version property discipline, OSS / update channels,
    minor / patch / RC flows, mobile sync contract, rollback policy, checklist.
  • cut-release.sh — helper script that:
    • validates the current state (on main, clean tree, in sync with origin,
      properties version matches),
    • creates release/X.Y from main HEAD and pushes it,
    • on main, creates a chore/bump-to-X.(Y+1).0 branch with the properties
      bump and pushes it (PR creation left manual on purpose),
    • prints the next-step tag commands.

What's NOT in this PR

The actual release flow described in Releasing.md will only work end-to-end
after the CI changes land:

  • build-release.yml branch guard + RC tag pattern + channel-aware OSS path
  • validateAndUpdateVersion.js enabling RC handling
  • Update manifest / Conveyor channel split
  • doc/MOBILE_COMPAT.md initialization

Each of those will land as its own PR — see #4439 for the full rollout plan
and open questions.

Why draft

Opened as draft so the design can be reviewed and refined offline before any
of the wiring lands. The issue body has the full proposal; please leave
feedback there if anything in the model needs to change.

Phase 1 of #4439: introduces the documentation and helper script for the
release-branch + dark-merge workflow. No CI changes yet.

- doc/en/Releasing.md, doc/zh/Releasing.md: branch model, tag scheme,
  version property discipline, OSS / update channels, minor / patch / RC
  flows, mobile sync contract, rollback policy, checklist.
- cut-release.sh: cuts release/X.Y from main and creates a chore branch
  on main that bumps the version properties to the next minor.
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.

Introduce release branches and dark-merge workflow for parallel development

1 participant