Skip to content

Commit 243605e

Browse files
committed
docs: Add release-checklist.md
1 parent f3672c7 commit 243605e

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/release-checklist.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Release Checklist
2+
3+
## Steps
4+
5+
1. Sync with upstream llama.cpp and make the commit,
6+
7+
```
8+
chore: sync with llama.cpp upstream
9+
```
10+
11+
2. Update `CHANGELOG.md` with details on new features and bug fixes
12+
3. Increment `versionCode` and `versionName` in `build.gradle.kts` for `app` module
13+
4. Make a commit with the message,
14+
15+
```
16+
release: prepare for release <new-version-number>
17+
```
18+
19+
5. Create a new tag and push it to GitHub to initiate the CI pipeline for releasing,
20+
21+
```bash
22+
git tag <new-version-number>
23+
git push origin --tags
24+
```
25+
26+
## Deleting a Release/Tag from GitHub
27+
28+
1. Delete the release from GitHub
29+
2. Delete the corresponding tag from GitHub (thus deleting it from the remote `origin`)
30+
3. Delete the tag from your local machine
31+
32+
```bash
33+
git tag -d <new-version-number>
34+
```

0 commit comments

Comments
 (0)