Skip to content

Commit e36dd24

Browse files
committed
fix(ci): fix release notes always showing first release by adding fetch-depth: 0 and optimize release command workflow
1 parent e8303a4 commit e36dd24

2 files changed

Lines changed: 36 additions & 28 deletions

File tree

.github/workflows/release.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,8 @@ jobs:
307307
steps:
308308
- name: Checkout repository
309309
uses: actions/checkout@v4
310+
with:
311+
fetch-depth: 0
310312

311313
- name: Get version from tag
312314
id: get_version

.qoder/commands/release.md

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,39 @@ git log --oneline -10
2727
- 必须大于当前最新版本
2828
- 语义化:破坏性变更→主版本,新功能→次版本,修复→修订号
2929

30-
### 2. 同步所有版本号(共 7 处)
30+
### 2. 更新 README 变更日志
3131

32-
#### 2.1 后端版本(1 处)
32+
首先查看自上次发布以来的提交记录,确定变更内容:
33+
```bash
34+
# 查看自上次 tag 以来的提交
35+
git log $(git describe --tags --abbrev=0 2>/dev/null)..HEAD --oneline --no-merges
36+
```
37+
38+
`README.md``README_EN.md` 的变更日志章节顶部插入新版本记录:
39+
40+
```markdown
41+
### [v1.8.34] - 2026-02-27
42+
43+
#### ✨ 新增
44+
- <新功能描述>
45+
46+
#### 🐛 修复
47+
- <问题修复>
48+
49+
#### 📝 其他
50+
- <其他变更>
51+
```
52+
53+
> **注意**:中英文 README 的变更日志必须同步更新。
54+
55+
### 3. 同步所有版本号(共 7 处)
56+
57+
#### 3.1 后端版本(1 处)
3358
| 文件 | 位置 | 格式 |
3459
|------|------|------|
3560
| `src/backEnd/config.py` | 第 7 行 | `VERSION = "1.8.34"` |
3661

37-
#### 2.2 Burp 插件版本(6 处)
62+
#### 3.2 Burp 插件版本(6 处)
3863
| 文件 | 位置 | 格式 |
3964
|------|------|------|
4065
| `src/burpEx/legacy-api/pom.xml` | 第 9 行 | `<version>1.8.34</version>` |
@@ -78,35 +103,16 @@ grep -rn "旧版本号" src/backEnd/config.py src/burpEx/
78103
- [ ] 7 处版本号已全部更新
79104
- [ ] 版本号格式正确(不含 `v` 前缀)
80105

81-
**提交:**
82-
```bash
83-
git add src/backEnd/config.py src/burpEx/
84-
git commit -m "chore: bump version to 1.8.34"
85-
```
86-
87-
### 3. 更新 README 变更日志
88-
`README.md` 的变更日志章节顶部插入新版本记录:
106+
### 4. 一次性提交所有版本发布变更
89107

90-
```markdown
91-
### [v1.8.34] - 2026-02-27
92-
93-
#### ✨ 新增
94-
- <新功能描述>
95-
96-
#### 🐛 修复
97-
- <问题修复>
98-
99-
#### 📝 其他
100-
- <其他变更>
101-
```
108+
> **关键**:所有版本相关的修改(版本号 + 变更日志)必须在同一个 commit 中提交,不要拆分成多个 commit。
102109
103-
**提交:**
104110
```bash
105-
git add README.md
106-
git commit -m "docs: update changelog for v1.8.34"
111+
git add src/backEnd/config.py src/burpEx/ README.md README_EN.md
112+
git commit -m "chore: release v1.8.34"
107113
```
108114

109-
### 4. 创建 Tag 并推送
115+
### 5. 创建 Tag 并推送
110116

111117
> **重要**:本项目使用 `release-v版本号` 格式的 Tag 触发 GitHub Actions
112118
@@ -126,7 +132,7 @@ git push origin master
126132
git push origin release-v1.8.34
127133
```
128134

129-
### 5. 验证发布
135+
### 6. 验证发布
130136
- [ ] GitHub Actions 工作流已触发(查看 Actions 标签页)
131137
- [ ] 等待构建完成(约 3-5 分钟)
132138
- [ ] GitHub Releases 页面出现新版本

0 commit comments

Comments
 (0)