Skip to content

Commit 7f62dd2

Browse files
cbh123claude
andcommitted
Add release documentation
Document the release process and how to run releases with pnpm run release. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
1 parent 207ab13 commit 7f62dd2

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

RELEASING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Releasing Chorus
2+
3+
## Quick Start
4+
5+
To release a new version of Chorus:
6+
7+
```bash
8+
pnpm run release
9+
```
10+
11+
That's it!
12+
13+
## What Happens
14+
15+
The release script (`script/release.sh`) does the following:
16+
17+
1. Runs TypeScript compilation to check for errors
18+
2. Checks out `main` and pulls the latest changes
19+
3. Checks out the `release` branch
20+
4. Pulls `main` into `release` (fast-forward merge)
21+
5. Pushes `release` to GitHub
22+
6. Switches back to `main`
23+
24+
Once the `release` branch is pushed, GitHub Actions automatically:
25+
26+
1. Creates a draft release on CrabNebula Cloud
27+
2. Builds the app for both Intel (`x86_64`) and Apple Silicon (`aarch64`) Macs
28+
3. Signs and notarizes the app with Apple
29+
4. Uploads the build artifacts to CrabNebula Cloud
30+
5. Sends a Slack notification when complete
31+
32+
## Monitoring
33+
34+
Check release status at: https://github.com/meltylabs/chorus-oss/actions
35+
36+
Download releases at: https://web.crabnebula.cloud/chorus/chorus

0 commit comments

Comments
 (0)