Skip to content

docs: add release guide and link from README#34

Merged
oahsiao merged 1 commit into
mainfrom
docs/release-guide
Jun 24, 2026
Merged

docs: add release guide and link from README#34
oahsiao merged 1 commit into
mainfrom
docs/release-guide

Conversation

@oahsiao

@oahsiao oahsiao commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Adds a formal, version-controlled release guide and links it from the README.

What

  • New docs/RELEASE.md documenting the verified release process:
    • Branch protection + 4 required checks
    • Versioning rules incl. the RELEASE shortcut (default = patch +1)
    • 8-step cut-a-release flow (branch -> PR -> merge -> tag merge commit)
    • Dual-arch (x64 + ARM64) build outputs
    • Gotchas (tag on merge commit, watch TUI, Node 20 deprecation)
  • README EN + ZH build sections now link to the guide.

Docs only - no code or workflow changes.

@oahsiao oahsiao merged commit 4dca07c into main Jun 24, 2026
5 checks passed
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