Getting Started
Getting Started
Connect GitHub, link a repo, and publish a reviewed release from the dashboard or automation API.
Edit this pageGetting Started
Dashboard setup
- Sign in with GitHub from
https://releasemind.ai/start. - Install or manage the ReleaseMind GitHub App for the org that owns the repo.
- Open Repos and confirm the target repo is visible.
- Create a ReleaseMind repo record if the repo is visible but not linked.
- 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.
Automation setup
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.
There is no currently published SI orbit client after the SI orbit extraction. A future ReleaseMind CLI client should use the same ReleaseMind session, GitHub installation, repo-linking, billing gate, generation worker, and publish service as the dashboard.
First GitHub release
Use Release Studio in the dashboard for interactive release creation and review. Use /api/automation/releases/prepare, /status, and /publish for unattended CI flows.
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 devUse SI Fort for runtime secrets. Do not keep plaintext production secrets in the working tree.