@zjex/git-workflow 0.3.10 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +470 -12
- package/README.md +8 -3
- package/ROADMAP.md +1 -1
- package/dist/index.js +229 -30
- package/docs/.vitepress/config.ts +111 -100
- package/docs/commands/branch.md +33 -12
- package/docs/commands/index.md +38 -33
- package/docs/commands/tag.md +71 -15
- package/docs/commands/update.md +79 -3
- package/docs/guide/api.md +607 -0
- package/docs/guide/contributing.md +441 -0
- package/docs/guide/development.md +295 -0
- package/docs/guide/team-collaboration.md +538 -0
- package/docs/guide/testing.md +461 -0
- package/package.json +3 -3
- package/scripts/generate-changelog-manual.js +135 -0
- package/src/commands/stash.ts +176 -7
- package/src/commands/tag.ts +120 -0
- package/src/index.ts +89 -72
- package/src/update-notifier.ts +1 -1
- package/tests/commands.test.ts +409 -0
- package/tests/stash.test.ts +161 -89
- package/tests/tag.test.ts +236 -0
- package/tests/update-notifier.test.ts +52 -0
- package/CODE_DOCUMENTATION.md +0 -169
- package/TESTING.md +0 -436
package/docs/commands/tag.md
CHANGED
|
@@ -4,12 +4,13 @@ Tag 管理相关的命令详解。
|
|
|
4
4
|
|
|
5
5
|
## 📋 命令列表
|
|
6
6
|
|
|
7
|
-
| 命令
|
|
8
|
-
|
|
9
|
-
| `gw tags [prefix]` | `gw ts` | 列出 tag
|
|
10
|
-
| `gw tag [prefix]`
|
|
11
|
-
| `gw tag:
|
|
12
|
-
| `gw tag:update`
|
|
7
|
+
| 命令 | 别名 | 说明 |
|
|
8
|
+
| ------------------ | ------- | ------------ |
|
|
9
|
+
| `gw tags [prefix]` | `gw ts` | 列出 tag |
|
|
10
|
+
| `gw tag [prefix]` | `gw t` | 创建 tag |
|
|
11
|
+
| `gw tag:del` | `gw td` | 删除 tag |
|
|
12
|
+
| `gw tag:update` | `gw tu` | 修改 tag |
|
|
13
|
+
| `gw tag:clean` | `gw tc` | 清理无效 tag |
|
|
13
14
|
|
|
14
15
|
## 📋 列出 Tag
|
|
15
16
|
|
|
@@ -32,7 +33,7 @@ $ gw ts
|
|
|
32
33
|
📋 所有 tags (按时间倒序):
|
|
33
34
|
|
|
34
35
|
v1.2.0 Release v1.2.0 2 days ago
|
|
35
|
-
v1.1.0 Release v1.1.0 1 week ago
|
|
36
|
+
v1.1.0 Release v1.1.0 1 week ago
|
|
36
37
|
v1.0.0 Initial release 2 weeks ago
|
|
37
38
|
|
|
38
39
|
共 3 个 tags
|
|
@@ -139,23 +140,78 @@ $ gw tu
|
|
|
139
140
|
✔ 已推送到远程
|
|
140
141
|
```
|
|
141
142
|
|
|
143
|
+
## 🧹 清理无效 Tag
|
|
144
|
+
|
|
145
|
+
### 基本用法
|
|
146
|
+
|
|
147
|
+
```bash
|
|
148
|
+
gw tag:clean
|
|
149
|
+
gw tc
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### 什么是无效 Tag
|
|
153
|
+
|
|
154
|
+
无效 tag 是指那些不包含有效版本号的标签,通常是由于脚本错误或配置问题产生的,例如:
|
|
155
|
+
|
|
156
|
+
- `vnull` - 版本号为 null
|
|
157
|
+
- `vundefined` - 版本号为 undefined
|
|
158
|
+
- `v` - 空版本号
|
|
159
|
+
- 其他不符合版本规范的标签
|
|
160
|
+
|
|
161
|
+
### 清理流程
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
$ gw tc
|
|
165
|
+
🧹 清理无效 tag
|
|
166
|
+
|
|
167
|
+
检测到以下无效 tag:
|
|
168
|
+
|
|
169
|
+
vnull
|
|
170
|
+
提交: abc1234 (2 days ago)
|
|
171
|
+
作者: John Doe
|
|
172
|
+
消息: Release vnull
|
|
173
|
+
|
|
174
|
+
vundefined
|
|
175
|
+
提交: def5678 (1 week ago)
|
|
176
|
+
作者: Jane Smith
|
|
177
|
+
消息: Release vundefined
|
|
178
|
+
|
|
179
|
+
? 是否删除这些无效 tag?
|
|
180
|
+
❯ 是,删除本地和远程
|
|
181
|
+
取消
|
|
182
|
+
|
|
183
|
+
✔ 本地 tag 已删除: vnull
|
|
184
|
+
✔ 远程 tag 已删除: origin/vnull
|
|
185
|
+
✔ 本地 tag 已删除: vundefined
|
|
186
|
+
✔ 远程 tag 已删除: origin/vundefined
|
|
187
|
+
|
|
188
|
+
✔ 已清理 2 个无效 tag
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### 安全性
|
|
192
|
+
|
|
193
|
+
- 只会删除明确不包含数字的标签
|
|
194
|
+
- 删除前会显示详细信息供确认
|
|
195
|
+
- 支持仅删除本地或同时删除远程
|
|
196
|
+
- 不会影响正常的版本标签
|
|
197
|
+
|
|
142
198
|
## 🔧 版本类型详解
|
|
143
199
|
|
|
144
200
|
### 标准版本
|
|
145
201
|
|
|
146
|
-
| 类型
|
|
147
|
-
|
|
202
|
+
| 类型 | 说明 | 示例 |
|
|
203
|
+
| ------- | ------------------ | ------------- |
|
|
148
204
|
| `patch` | 补丁版本,Bug 修复 | 1.0.0 → 1.0.1 |
|
|
149
|
-
| `minor` | 次版本,新功能
|
|
205
|
+
| `minor` | 次版本,新功能 | 1.0.0 → 1.1.0 |
|
|
150
206
|
| `major` | 主版本,破坏性变更 | 1.0.0 → 2.0.0 |
|
|
151
207
|
|
|
152
208
|
### 预发布版本
|
|
153
209
|
|
|
154
|
-
| 类型
|
|
155
|
-
|
|
210
|
+
| 类型 | 说明 | 示例 |
|
|
211
|
+
| ------- | ---------- | --------------------- |
|
|
156
212
|
| `alpha` | 内部测试版 | 1.0.0 → 1.0.1-alpha.1 |
|
|
157
|
-
| `beta`
|
|
158
|
-
| `rc`
|
|
213
|
+
| `beta` | 公开测试版 | 1.0.0 → 1.0.1-beta.1 |
|
|
214
|
+
| `rc` | 发布候选版 | 1.0.0 → 1.0.1-rc.1 |
|
|
159
215
|
|
|
160
216
|
### 预发布版本升级
|
|
161
217
|
|
|
@@ -275,4 +331,4 @@ gw tag
|
|
|
275
331
|
1.0.0-beta.2 → 修复反馈
|
|
276
332
|
1.0.0-rc.1 → 发布候选
|
|
277
333
|
1.0.0 → 正式发布
|
|
278
|
-
```
|
|
334
|
+
```
|
package/docs/commands/update.md
CHANGED
|
@@ -4,9 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
## 📋 命令概览
|
|
6
6
|
|
|
7
|
-
| 命令
|
|
8
|
-
|
|
7
|
+
| 命令 | 别名 | 说明 |
|
|
8
|
+
| ----------- | -------- | -------------------- |
|
|
9
9
|
| `gw update` | `gw upt` | 检查并更新到最新版本 |
|
|
10
|
+
| `gw clean` | `gw cc` | 清理缓存和临时文件 |
|
|
10
11
|
|
|
11
12
|
## 🔄 版本更新
|
|
12
13
|
|
|
@@ -344,4 +345,79 @@ diff ~/.gwrc.json.backup ~/.gwrc.json
|
|
|
344
345
|
# 监控版本状态
|
|
345
346
|
gw --version
|
|
346
347
|
gw update --check-only # 仅检查,不更新
|
|
347
|
-
```
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
## 🧹 清理缓存
|
|
351
|
+
|
|
352
|
+
### 基本用法
|
|
353
|
+
|
|
354
|
+
```bash
|
|
355
|
+
gw clean
|
|
356
|
+
gw cc
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
### 清理内容
|
|
360
|
+
|
|
361
|
+
工具会清理以下文件:
|
|
362
|
+
|
|
363
|
+
1. **更新缓存** - `~/.gw-update-check`
|
|
364
|
+
2. **全局配置** - `~/.gwrc.json` (可选)
|
|
365
|
+
3. **临时文件** - `/tmp/.gw-commit-msg-*`
|
|
366
|
+
|
|
367
|
+
### 清理流程
|
|
368
|
+
|
|
369
|
+
```bash
|
|
370
|
+
$ gw clean
|
|
371
|
+
? 检测到全局配置文件,是否删除?
|
|
372
|
+
❯ 否,保留配置文件
|
|
373
|
+
是,删除配置文件
|
|
374
|
+
|
|
375
|
+
✔ 已清理 3 个文件
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
### 删除全局配置
|
|
379
|
+
|
|
380
|
+
如果选择删除全局配置文件:
|
|
381
|
+
|
|
382
|
+
```bash
|
|
383
|
+
$ gw clean
|
|
384
|
+
? 检测到全局配置文件,是否删除?
|
|
385
|
+
❯ 是,删除配置文件
|
|
386
|
+
|
|
387
|
+
✔ 已清理 5 个文件
|
|
388
|
+
|
|
389
|
+
⚠️ 全局配置文件已删除
|
|
390
|
+
如需重新配置,请运行: gw init
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
### 使用场景
|
|
394
|
+
|
|
395
|
+
**定期清理:**
|
|
396
|
+
|
|
397
|
+
```bash
|
|
398
|
+
# 清理缓存,释放空间
|
|
399
|
+
gw clean
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
**重置配置:**
|
|
403
|
+
|
|
404
|
+
```bash
|
|
405
|
+
# 删除配置后重新初始化
|
|
406
|
+
gw clean # 选择删除配置
|
|
407
|
+
gw init # 重新配置
|
|
408
|
+
```
|
|
409
|
+
|
|
410
|
+
**故障排除:**
|
|
411
|
+
|
|
412
|
+
```bash
|
|
413
|
+
# 清理缓存解决更新检查问题
|
|
414
|
+
gw clean
|
|
415
|
+
gw update
|
|
416
|
+
```
|
|
417
|
+
|
|
418
|
+
### 安全性
|
|
419
|
+
|
|
420
|
+
- 删除全局配置前会询问确认
|
|
421
|
+
- 不会删除项目级配置文件
|
|
422
|
+
- 不会影响 Git 仓库数据
|
|
423
|
+
- 可以随时通过 `gw init` 重新配置
|