Skip to content

Commit 20d3240

Browse files
committed
Add release process documentation
1 parent c639d7f commit 20d3240

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

RELEASE.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Release Process
2+
3+
## 1. Bump version
4+
5+
```bash
6+
# Edit Cargo.toml version
7+
vim Cargo.toml
8+
9+
git add Cargo.toml Cargo.lock
10+
git commit -m "Bump version to X.Y.Z"
11+
git push origin main
12+
```
13+
14+
## 2. Tag and push
15+
16+
```bash
17+
git tag vX.Y.Z
18+
git push origin vX.Y.Z
19+
```
20+
21+
This triggers the [Release workflow](https://github.com/tcdent/codey/actions/workflows/release.yml) which builds for:
22+
- `codey-darwin-arm64` (macOS ARM)
23+
- `codey-linux-x86_64` (Linux x86)
24+
- `codey-linux-arm64` (Linux ARM)
25+
26+
## 3. Update Homebrew tap
27+
28+
Once the release workflow completes, get SHA256 hashes:
29+
30+
```bash
31+
VERSION=X.Y.Z
32+
curl -sL https://github.com/tcdent/codey/releases/download/v$VERSION/codey-darwin-arm64.tar.gz | shasum -a 256
33+
curl -sL https://github.com/tcdent/codey/releases/download/v$VERSION/codey-linux-x86_64.tar.gz | shasum -a 256
34+
curl -sL https://github.com/tcdent/codey/releases/download/v$VERSION/codey-linux-arm64.tar.gz | shasum -a 256
35+
```
36+
37+
Update `~/Work/tap/Formula/codey.rb`:
38+
- `version "X.Y.Z"`
39+
- SHA256 hashes for each platform
40+
41+
```bash
42+
cd ~/Work/tap
43+
git add -A
44+
git commit -m "Update codey to vX.Y.Z"
45+
git push
46+
```
47+
48+
## Version scheme
49+
50+
```
51+
0.1.0-alpha.1 # Early development
52+
0.1.0-rc.1 # Release candidate
53+
0.1.0 # Stable release
54+
```

0 commit comments

Comments
 (0)