Workflow

Release Workflow

Recommended draft-review-publish sequence for predictable GitHub releases.

Edit this page

Release Workflow

Draft

ReleaseMind builds drafts from repo metadata, tags, recent commits, pull requests, and GitHub release history. A draft can be started from the dashboard, from si orbit releasemind release create, or from an automation prepare request.

Use clear tags such as v1.2.0 and stable merge practices. For generated notes, pass a base tag when the release boundary should be explicit.

Review

Review the title, summary, and body before publishing. ReleaseMind intentionally keeps a human approval step between generation and public release.

Recommended checks:

  • Verify links and referenced IDs
  • Ensure customer-facing language is concise and non-ambiguous
  • Keep rollback and known-issues sections explicit
  • Confirm the release URL points at the intended GitHub tag
  • Remove empty sections such as "Breaking Changes" when there are none

GitHub draft

Create or update the GitHub draft release from the reviewed ReleaseMind post. ReleaseMind stores the GitHub release id, URL, release state, and timestamps so the dashboard and CLI remain in sync.

Publish

Publishing turns the GitHub draft into a public release. Complete required runbook gates before final publish so version, validation, docs, approval, draft, publish, and verification evidence stays attached to the ReleaseMind post. The operation is idempotent: rerunning publish for an already-published release returns the stored published state instead of creating a duplicate.

Verify

After publishing, use the dashboard or CLI to confirm:

si orbit releasemind release view \
  --repo Aureuma/example-repo \
  <post-id> \
  --json

Look for status: "published", release_state: "published", and a canonical URL such as https://github.com/OWNER/REPO/releases/tag/v1.2.0.