Skip to content

Commit 17b7f87

Browse files
committed
docs: add release workflow and document naming/gh CLI flags
1 parent 2578d0a commit 17b7f87

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

.agents/workflows/release.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
description: Create a new Mole release and update versions
3+
---
4+
5+
# Mole Release Workflow
6+
7+
Follow these steps when you are ready to publish a new release of Mole.
8+
9+
1. **Update the version number** in the main executable:
10+
// turbo
11+
12+
```bash
13+
# Replace the version number below with the target version (e.g., 1.30.0)
14+
# sed -i '' 's/VERSION=".*"/VERSION="1.30.0"/' mole
15+
```
16+
17+
2. **Generate Release Notes**:
18+
Review the commits since the last release, categorize the changes (Bug Fixes, Features, Refactoring), and format them into both English and Chinese changelogs following the structure in previous releases. Save this exactly to `/tmp/release_notes.md`.
19+
20+
3. **Commit the changes**:
21+
// turbo
22+
23+
```bash
24+
git add mole
25+
# For example: git commit -m "chore: Bump version to 1.30.0"
26+
```
27+
28+
4. **Tag the release**:
29+
// turbo
30+
31+
```bash
32+
# For example: git tag V1.30.0
33+
```
34+
35+
5. **Push commits and tags to remote**:
36+
// turbo
37+
38+
```bash
39+
git push origin main
40+
git push origin --tags
41+
```
42+
43+
6. **Create the GitHub Release**:
44+
Use `gh release create` directly so GitHub does not auto-append generic commit/contributor logs. **Important:** Specify `-R tw93/Mole` to avoid the "No default remote repository" error.
45+
The release title should be named after characters from either *Stranger Things* (e.g., Mike Wheeler) or *Bakemonogatari*, accompanied by a relevant emoji.
46+
// turbo
47+
48+
```bash
49+
# For example (no auto-generated logs added when using -F):
50+
# gh release create V1.30.0 -R tw93/Mole -F /tmp/release_notes.md -t "V1.30.0 Mike Wheeler 🚲"
51+
```
52+
53+
*(Note: Adjust the commands manually for the specific version number during the actual release)*

0 commit comments

Comments
 (0)