Get started

Quickstart

Connect a repo, add signing, and start a ReleaseKit build.

1. Connect GitHub

Install the ReleaseKit GitHub App on the repository that contains your desktop app. ReleaseKit uses it to read source, list branches, and check out commits in hosted builders.

2. Create a project

In the dashboard, choose the repository and Production branch. Leave Nightly unset until you want a prerelease feed.

3. Confirm recipe and signing

ReleaseKit detects the app root, package manager, install/build commands, artifacts, and target arches. Confirm the recipe, then add an Apple signing profile.

4. Install the CLI

npm install -g @sandbox-technologies/release-kit
release-kit login

login opens the dashboard, authenticates with the same WorkOS account, and lets you choose the active project.

5. Build

Use Preview while developing:

release-kit preview

Publish Nightly or Production when you want a promotable candidate:

release-kit publish nightly
release-kit publish production

The CLI asks for a patch, minor, or major bump when needed. You can also pass --patch, --minor, or --major. Production and Nightly update the app version file, commit that bump, push it, and create the candidate from the pushed commit. Nightly versions start from the current Nightly baseline. Approving a Production release also advances the Nightly feed to that final build, so the next explicit Nightly publish starts the following prerelease train.

6. Promote

Open the build link printed by the CLI. When checks pass, approve Production to update the stable feed and converge Nightly users, or approve Nightly to update the nightly feed with a prerelease.

Preview never updates a feed.