Automation API runbook

Use prepare, status, and publish endpoints for unattended release workflows.

Updated: Feb 1, 2026

Prepare

POST /api/automation/releases/prepare with repo_full_name, release_tag, and optional base_tag or head_ref.

Use wait_for_ready when the caller should block until generation completes.

The response includes the ReleaseMind post id to use for status and publish.

Status

GET /api/automation/releases/status with repo_full_name and post_id.

Poll until status is ready, drafted, published, or failed.

Surface failed states in CI instead of publishing partial notes.

Publish

POST /api/automation/releases/publish with repo_full_name and post_id.

Publish is idempotent for already-published GitHub releases.

Required release runbook gates should be complete before final publish.

Verify release_state, status, and release_url in the response.

Review and introspect

Automation is safest when it still has explicit release gates.

  • What deterministic checks run before prepare?
  • Who approves generated notes before publish?
  • What post-publish verification proves the release is usable?

Need more help?

Support

Email

Email [email protected] with your org, repo, and release tag for the fastest response.

Email support

Related articles

CLI client contract

Understand how future CLI clients should use the ReleaseMind backend contract.

Automation tokens

Create scoped bearer tokens for CI, scripts, and unattended release runbooks.

Was this article helpful?