Getting Started

Getting Started

Connect GitHub, link a repo, and publish a reviewed release from the dashboard or SI CLI.

Edit this page

Getting Started

Dashboard setup

  1. Sign in with GitHub from https://releasemind.ai/start.
  2. Install or manage the ReleaseMind GitHub App for the org that owns the repo.
  3. Open Repos and confirm the target repo is visible.
  4. Create a ReleaseMind repo record if the repo is visible but not linked.
  5. Open Release Studio and generate a first draft.

ReleaseMind needs GitHub App access to the repository that owns tags, pull requests, and release history. If an org uses GitHub SSO, approve the app before troubleshooting missing repos.

SI CLI setup

si orbit releasemind auth login
si orbit releasemind auth status --json
si orbit releasemind doctor Aureuma/example-repo --json
si orbit releasemind repo ensure-link Aureuma/example-repo --json

The CLI uses the same ReleaseMind session, GitHub installation, repo-linking, billing gate, generation worker, and publish service as the dashboard.

First GitHub release

si orbit releasemind release create v1.2.0 \
  --repo Aureuma/example-repo \
  --title "Example Repo v1.2.0" \
  --draft \
  --json

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

si orbit releasemind runbook status \
  --repo Aureuma/example-repo \
  <post-id> \
  --json

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

Use --notes when you already have reviewed release notes and want ReleaseMind to create the GitHub release with that content. Use --base-tag when generating notes from a specific prior tag boundary.

Complete required runbook gates before final publish. Evidence should point to reproducible checks, reviewed dashboard state, deployment IDs, or GitHub release URLs.

Automation tokens

Dashboard users can create repo-scoped automation tokens from Profile. Store tokens in the consuming repo's secret manager and prefer one token per repo.

Automation clients send:

Authorization: Bearer rmatk.<token-id>.<secret>

Local development

From the repo root, use pnpm:

corepack pnpm install --frozen-lockfile
corepack pnpm run dev

Use SI Fort for runtime secrets. Do not keep plaintext production secrets in the working tree.