@elvis1513/auto-coding-skill 0.3.0 → 1.0.0

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.
@@ -12,9 +12,12 @@ project:
12
12
  commands:
13
13
  build: ""
14
14
  test: ""
15
+ quick_test: ""
15
16
  lint: ""
16
17
  typecheck: ""
17
18
  format: ""
19
+ script_syntax: ""
20
+ diff_check: ""
18
21
  docker_build: ""
19
22
  compose_up: ""
20
23
  compose_down: ""
@@ -32,23 +35,42 @@ runtime:
32
35
  env_file: ""
33
36
  startup_timeout_sec: 120
34
37
 
38
+ target_env:
39
+ name: ""
40
+ frontend_base_url: ""
41
+ frontend_username: ""
42
+ frontend_password: ""
43
+ backend_base_url: ""
44
+ backend_username: ""
45
+ backend_password: ""
46
+ health_base_url: ""
47
+ health_path: ""
48
+ verify_notes: ""
49
+
35
50
  jenkins:
51
+ base_url: ""
52
+ ui_username: ""
53
+ ui_password: ""
54
+ crumb_url: ""
36
55
  job_name: ""
37
56
  job_url: ""
57
+ multibranch_root_job: ""
58
+ branch_name: ""
38
59
  trigger_branch: ""
39
60
  image_repository: ""
40
61
  image_tag_strategy: ""
41
62
  deploy_env: ""
42
63
  deploy_timeout_sec: 1800
43
- prod_health_base_url: ""
44
- prod_health_path: ""
45
64
  api_user: ""
46
65
  api_token: ""
66
+ api_password: ""
47
67
  api_user_env: "JENKINS_USER"
48
68
  api_token_env: "JENKINS_TOKEN"
69
+ api_password_env: "JENKINS_PASSWORD"
49
70
 
50
71
  docs:
51
72
  taskbook: "docs/tasks/taskbook.md"
73
+ closure_log: "docs/tasks/closure-log.md"
52
74
  design_dir: "docs/design"
53
75
  review_dir: "docs/reviews"
54
76
  api_doc: "docs/interfaces/api.md"
@@ -58,40 +80,78 @@ docs:
58
80
  summary_dir: "docs/tasks/summaries"
59
81
  ---
60
82
 
61
- # docs/ENGINEERING.md — AutoPipeline Gates (Source of Truth)
83
+ # docs/ENGINEERING.md — Lightweight Default Workflow (Source of Truth)
62
84
 
63
- 目标:把一次任务固化为不可跳过的流水线:
64
- 读任务写DD实现本地构建/测试通过静态分析+Review落盘更新 API Markdown+接口变更清单
65
- 本地 Docker Compose 启动验证 → 本地健康检查 → 对本地环境全量回归 + 回归矩阵 0 fail →
66
- 记录 Bug 并新增自动化回归 → 任务总结落盘 → commit → push 触发 Jenkins → Jenkins 构建镜像并更新目标环境 →
67
- 生产健康检查通过
85
+ 目标:默认采用高效率开发闭环:
86
+ 需求/任务记录最小设计开发实现本地轻量校验commit/pushJenkins 构建部署 目标环境验证 闭环记录
68
87
 
69
- 规则:任一步骤失败或缺产物,禁止进入下一步;本地 compose 验证未通过禁止 commit;Jenkins 未成功或生产健康检查未通过,任务不视为完成。
88
+ 默认原则:
89
+ - 默认不要求本地 Docker Compose 启动。
90
+ - 默认不要求本地 Docker build。
91
+ - 默认不要求本地完整 smoke / regression。
92
+ - 默认不要求每个小改动生成长 summary。
93
+ - 默认不要求 regression matrix 全 PASS。
94
+ - 默认不要求 deployment record。
95
+ - Jenkins 构建结果和目标环境真实验证,比本地模拟更重要。
70
96
 
71
97
  补充规则:
72
- - 每次任务闭环后,必须清理临时文件、临时目录、日志、截图、回归中间产物、构建缓存等非必要产物;仅 `.local/` 下的本地运行数据允许保留。
98
+ - 每次任务闭环后,必须清理临时文件、临时目录、日志、截图、构建缓存等非必要产物;仅明确需要保留的本地诊断目录允许保留。
99
+ - 所有手工填写信息,只维护在本文件 frontmatter 中,其他文档不得重复配置。
73
100
 
74
101
  ---
75
102
 
76
103
  ## 0. 配置填写(必须)
77
104
 
78
- 先填写 `docs/ENGINEERING.md` frontmatter 中的所有空值(例如 Go/前端目录、Docker 文件、Compose 服务、Jenkins Job、健康检查地址、命令)。
79
- 禁止在其他 md/yaml 重复维护这些配置。
105
+ 先填写 `docs/ENGINEERING.md` frontmatter 中的所有空值。重点包括:
106
+ - `commands.*`:本地轻量校验命令
107
+ - `target_env.*`:目标环境地址、后台账号、前端验证信息
108
+ - `jenkins.*`:Jenkins UI/API 账号、Job、分支、镜像、部署环境
109
+
110
+ 字段说明:
111
+ - `target_env.backend_username` / `target_env.backend_password`:目标环境后台账号
112
+ - `target_env.frontend_username` / `target_env.frontend_password`:目标环境前端登录账号(如需要)
113
+ - `jenkins.ui_username` / `jenkins.ui_password`:Jenkins 页面登录账号
114
+ - `jenkins.api_user` + `jenkins.api_token` / `jenkins.api_password`:Jenkins API 校验凭据
115
+
116
+ 默认必填:
117
+ - `project.name`
118
+ - `commands.build`
119
+ - `commands.quick_test` 或 `commands.test`
120
+ - `commands.lint` 或 `commands.typecheck`
121
+ - `target_env.name`
122
+ - `target_env.health_base_url`
123
+ - `target_env.health_path`
124
+ - `jenkins.trigger_branch`
125
+ - `jenkins.image_repository`
126
+ - `jenkins.image_tag_strategy`
127
+ - `jenkins.deploy_env`
128
+ - `jenkins.job_url` 或 `jenkins.base_url + jenkins.job_name` 或 `jenkins.base_url + jenkins.multibranch_root_job`
129
+
130
+ 按需填写:
131
+ - `runtime.*`:仅在本地运行诊断时使用
132
+ - `commands.compose_up` / `commands.compose_down` / `commands.smoke` / `commands.regression`
133
+ - `target_env.frontend_*` / `target_env.backend_*`:仅在需要额外页面/API验证或受保护资源校验时使用
80
134
 
81
135
  ---
82
136
 
83
137
  ## 1. 权威输入与冲突裁决(优先级)
84
138
 
85
- 1) docs/ENGINEERING.md(本文件)
86
- 2) docs/tasks/taskbook.md
87
- 3) docs/design/**
88
- 4) docs/interfaces/api.md
89
- 5) docs/interfaces/api-change-log.md
90
- 6) docs/testing/regression-matrix.md(必须 0 FAIL)
91
- 7) docs/bugs/bug-list.md(长期积累,回归必测)
92
- 8) docs/tasks/summaries/**(每任务一份,强制产物)
93
- 9) docs/deployment/**
94
- 10) 代码实现(不得反向覆盖 1~9)
139
+ 1) `docs/ENGINEERING.md`
140
+ 2) `docs/tasks/taskbook.md`
141
+ 3) `docs/design/**`
142
+ 4) `docs/interfaces/api.md`
143
+ 5) `docs/interfaces/api-change-log.md`
144
+ 6) `docs/testing/regression-matrix.md`
145
+ 7) `docs/bugs/bug-list.md`
146
+ 8) `docs/tasks/closure-log.md`
147
+ 9) `docs/tasks/summaries/**`
148
+ 10) `docs/deployment/**`
149
+ 11) 代码实现
150
+
151
+ 说明:
152
+ - `closure-log.md` 是每个任务默认必须留下的轻量闭环记录。
153
+ - `summaries/**` 只用于跨模块、高风险、阶段性里程碑、需要完整复盘的任务。
154
+ - `deployment/**` 只用于真实部署记录、手工发布或高风险发布场景。
95
155
 
96
156
  ---
97
157
 
@@ -99,56 +159,113 @@ docs:
99
159
 
100
160
  优先使用当前环境已安装、已授权、已可访问的工具能力:
101
161
 
102
- 1) MCP servers
103
- 2) 已安装 skills
104
- 3) plugins / apps / connectors
162
+ 1) MCP servers
163
+ 2) 已安装 skills
164
+ 3) plugins / apps / connectors
105
165
  4) shell / 手工实现
106
166
 
107
167
  规则:
108
- - 做设计、查资料、看文档、看页面、查知识库、写回外部系统时,优先调用现有 MCP / skills / plugins / apps。
109
- - 能用权威工具直接完成时,不重复手写中间数据。
110
- - 工具不可用、无权限、结果不可靠时,才回退到本地命令或手工处理。
111
- - 选择工具时优先“已安装且当前项目可直接使用”的能力,而不是重新造流程。
112
- - 查看 Jenkins、知识库、设计稿、页面、缺陷系统时,优先使用现成的连接器或 MCP,而不是手工拼接上下文。
168
+ - 做设计、查资料、查文档、查 Jenkins、查页面、写回外部系统时,优先调用现成能力。
169
+ - 工具不可用、权限不足、结果不可靠时,才回退到 shell 或手工流程。
170
+ - 不重复手写工具已经能直接读取或写回的权威数据。
113
171
 
114
172
  ---
115
173
 
116
174
  ## 1.6 多 Agent 协作策略(Claude / Codex 专属)
117
175
 
118
- 整个流程尽可能使用多 agent 模式并行推进。
176
+ 整个流程尽可能使用多 agent 并行推进。
119
177
 
120
178
  规则:
121
- - 任务开始后,优先拆分为可并行的子任务:设计补充、资料检索、实现分块、测试验证、文档回写、review。
122
- - agent 负责关键路径:任务定义、方案裁决、代码集成、质量门禁、最终交付。
123
- - agent 负责边界清晰、可独立推进的工作,完成后回收结果给主 agent 集成。
124
- - 如果某项工作会直接阻塞主路径且难以独立定义,不要机械拆分;由主 agent 保持控制。
125
- - 能并行就不要串行;能拆独立 write scope 就不要让多个 agent 写同一块内容。
179
+ - 主 agent 负责任务定义、方案裁决、代码集成、轻量门禁、Jenkins/目标环境闭环、最终交付。
180
+ - agent 优先拆为:设计/调研、后端实现、前端实现、验证/文档。
181
+ - 任务边界不清或需要强一致裁决时,由主 agent 保持控制,不机械拆分。
126
182
 
127
183
  ---
128
184
 
129
- ## 2. Gate 流水线(强制、不可跳过)
130
-
131
- Gate-1 读任务:只从 taskbook 取范围与验收;缺信息先补 taskbook
132
- Gate-2 写DD:无DD禁止写代码;DD必须含 时序图/ER图/接口时序(Mermaid)
133
- Gate-3 实现:严格按DD;接口变更必须同步 API Markdown
134
- Gate-4 本地CI:后端必须通过 `commands.test`;前端至少通过 `commands.build`、`commands.lint`、`commands.typecheck`;前端自动化测试能力逐步补齐
135
- Gate-5 静态分析+Review:静态分析通过;docs/reviews/ 生成记录
136
- Gate-6 文档:更新 api.md + 追加 api-change-log.md
137
- Gate-7 本地运行:必须用项目 Compose 启动本地 Docker 环境;失败先修复再继续
138
- Gate-8 健康检查:本地容器启动后必须健康检查通过
139
- Gate-9 全量回归:按 API Markdown 对本地 Compose 环境全量回归;回归矩阵仅可在真实执行后标记 PASS,且必须附证据;发现问题必须写 bug-list 并新增自动化回归用例
140
- Gate-10 Jenkins 准备:Jenkinsfile、Job 配置、镜像仓库策略必须可用
141
- Gate-11 任务总结:必须生成 docs/tasks/summaries/<TASK_ID>.md
142
- Gate-12 提交触发:本地门禁全过且临时产物已清理后,才允许 commit+push
143
- Gate-13 流水线验证:push 后必须确认 Jenkins 自动构建、镜像发布、目标环境更新成功
144
- Gate-14 完成:生产健康检查通过并补齐部署记录后,任务才完成
185
+ ## 2. 标准流程(默认)
186
+
187
+ 1. 需求确认
188
+ 明确任务范围、影响服务、是否涉及 API/数据库/部署/Jenkins/前端页面。
189
+
190
+ 2. 最小设计记录
191
+ 普通小改动只更新 `taskbook` 或设计文档中的最小必要段落;跨模块、接口、数据库、部署、Jenkins、关键页面流程变更才补 DD。
192
+
193
+ 3. 开发实现
194
+ 只修改本次任务必要文件,不做无关重构。
195
+
196
+ 4. 本地轻量校验
197
+ 默认只跑:
198
+ - 编译 / build
199
+ - 单元测试或关键快速测试
200
+ - lint / typecheck
201
+ - API 文档检查
202
+ - Jenkinsfile / 脚本语法检查
203
+ - `git diff --check`
204
+
205
+ 5. 立即提交推送
206
+ 轻量校验通过后,commit + push,触发 Jenkins。
207
+
208
+ 6. Jenkins 验证
209
+ 查看 Jenkins 构建、镜像、部署结果;失败则根据 Jenkins 日志修复,再次提交推送。
210
+
211
+ 7. 目标环境验证
212
+ 在真实目标环境做健康检查、关键接口、关键页面或业务路径验证。
213
+
214
+ 8. 回归与证据记录
215
+ 只有真实执行过 Jenkins / 目标环境验证,或显式要求本地运行验证时,才允许把 `regression-matrix.md` 标为 `PASS`。
216
+
217
+ 9. 闭环记录
218
+ 每个任务必须留下轻量闭环记录:任务 ID、提交号、Jenkins Build URL、目标环境验证结果、是否通过、遗留问题。
219
+
220
+ ---
221
+
222
+ ## 3. 高风险变更(必须补强验证)
223
+
224
+ 以下类型默认视为高风险变更:
225
+ - 数据库迁移
226
+ - 鉴权 / 权限
227
+ - 支付 / 订单
228
+ - 部署 / Jenkins
229
+ - Nginx / 网关
230
+ - 文件上传 / 下载
231
+ - 生产配置
232
+
233
+ 高风险变更至少额外要求:
234
+ - 明确 DD
235
+ - 目标环境真实验证
236
+ - 闭环记录写清楚验证路径和结果
237
+ - 必要时补 summary / deployment record / regression matrix
238
+
239
+ ---
240
+
241
+ ## 4. 本地 Docker 与完整回归(按需,不默认)
242
+
243
+ 以下能力保留,但仅用于显式要求、问题复现、Jenkins/目标环境问题前置诊断:
244
+ - `runtime-up`
245
+ - `runtime-down`
246
+ - 本地 health check
247
+ - 本地 `smoke`
248
+ - 本地 `regression`
249
+ - `check-matrix`
250
+ - `gen-summary`
251
+
252
+ 默认情况下,不把它们作为每个小改动的固定门禁。
145
253
 
146
254
  ---
147
255
 
148
- ## 3. Repo 工具入口
256
+ ## 5. Repo 工具入口
149
257
 
150
- 统一用 `python3 docs/tools/autopipeline/ap.py <command>` 执行。
258
+ 统一使用:
259
+ - `python3 docs/tools/autopipeline/ap.py doctor`
260
+ - `python3 docs/tools/autopipeline/ap.py light-gate`
261
+ - `python3 docs/tools/autopipeline/ap.py verify-jenkins-build ...`
262
+ - `python3 docs/tools/autopipeline/ap.py wait-health --scope target`
263
+ - `python3 docs/tools/autopipeline/ap.py verify-target ...`
264
+ - `python3 docs/tools/autopipeline/ap.py record-closure <TASK_ID> ...`
151
265
 
152
- 补充:
153
- - `commands.smoke` / `commands.regression` 可以封装 repo 脚本,但必须真正在本地运行目标系统。
154
- - `docs/testing/regression-matrix.md` 中的 `PASS` 只在真实执行并填入证据后允许保留;占位符证据会被视为未完成。
266
+ 说明:
267
+ - `doctor`:检查默认流程必填项和常见配置错误。
268
+ - `light-gate`:默认轻量门禁。
269
+ - `verify-target`:目标环境健康检查 + 按需关键 API / 页面验证。
270
+ - `record-closure`:默认轻量闭环记录。
271
+ - `check-matrix`、`gen-summary`、`runtime-up/down`:保留为按需工具。
@@ -1,4 +1,5 @@
1
- Follow docs/ENGINEERING.md strictly. Source of truth: docs/ENGINEERING.md.
1
+ Follow `docs/ENGINEERING.md` strictly. Source of truth: `docs/ENGINEERING.md`.
2
2
  Prefer already available MCP servers, installed skills, plugins, and app connectors during design, research, verification, and documentation workflows.
3
3
  Prefer multi-agent mode whenever the task can be split into independent parallel subtasks without weakening integration control.
4
- For Go monorepo + Jenkins projects, local Docker Compose validation must pass before commit, and push is expected to trigger Jenkins pipeline verification.
4
+ Default to the lightweight local gate first, then use Jenkins build verification and real target-environment verification as the primary completion gate.
5
+ Local Docker Compose and full local regression are on-demand diagnostic tools, not the default gate for every small change.
@@ -1,4 +1,5 @@
1
- Follow docs/ENGINEERING.md strictly. Source of truth: docs/ENGINEERING.md.
1
+ Follow `docs/ENGINEERING.md` strictly. Source of truth: `docs/ENGINEERING.md`.
2
2
  Prefer already available MCP servers, installed skills, plugins, and app connectors during design, research, verification, and documentation workflows.
3
3
  Prefer multi-agent mode whenever the task can be split into independent parallel subtasks without weakening integration control.
4
- For Go monorepo + Jenkins projects, local Docker Compose validation must pass before commit, and push is expected to trigger Jenkins pipeline verification.
4
+ Default to the lightweight local gate first, then use Jenkins build verification and real target-environment verification as the primary completion gate.
5
+ Local Docker Compose and full local regression are on-demand diagnostic tools, not the default gate for every small change.
@@ -1,28 +1,19 @@
1
1
  # Deploy Record — <Task ID> — YYYY-MM-DD
2
2
 
3
- ## 1. Local Compose Validation
4
- - Docker compose file:
5
- - Docker service:
6
- - Container name:
7
- - Image/tag:
8
- - Exposed port:
9
- - Env file:
10
- - Local health URL:
3
+ > 仅在真实需要独立部署审计记录时使用。
11
4
 
12
- ## 2. Jenkins Pipeline
13
- - Jenkins job name:
14
- - Jenkins build number:
15
- - Jenkins build URL:
16
- - Trigger branch:
17
- - Trigger commit:
18
- - Image repository:
19
- - Published image tag:
20
- - Deploy environment:
5
+ ## 1. Deployment Context
6
+ - Task ID:
7
+ - Commit:
8
+ - Jenkins Build:
9
+ - Target Env:
21
10
 
22
- ## 3. Evidence
23
- - docker ps / compose ps:
24
- - local_health_check:
25
- - smoke_test:
26
- - api_regression:
27
- - jenkins_result:
28
- - production_health_check:
11
+ ## 2. Verification
12
+ - Health check:
13
+ - Key API:
14
+ - Key page / business path:
15
+
16
+ ## 3. Notes
17
+ - Risk:
18
+ - Rollback:
19
+ - Follow-up:
@@ -1,19 +1,11 @@
1
- # Deployment Runbook(本地 Compose 验证 + Jenkins 自动部署)
1
+ # Deployment Runbook(按需使用,不是默认小改动产物)
2
2
 
3
- 统一读取:`docs/ENGINEERING.md` frontmatter
4
- - `runtime.*`:本地 Compose 启动与健康检查
5
- - `jenkins.*`:Jenkins Job、镜像仓库、目标环境、生产健康检查
3
+ 用途:
4
+ - 手工部署
5
+ - 高风险发布
6
+ - 需要额外审计证据的发布
6
7
 
7
- 执行顺序:
8
- 1. 本地构建、测试、lint、typecheck 通过
9
- 2. 本地 `docker compose` 启动目标服务
10
- 3. 本地 health / smoke / regression 全部通过
11
- 4. `commit + push`
12
- 5. Jenkins 自动触发,完成镜像构建、镜像推送、目标环境更新
13
- 6. 检查 Jenkins 结果与目标环境健康状态
14
-
15
- 完成条件:
16
- - 本地 Compose 验证通过
17
- - Jenkins Pipeline 成功
18
- - 目标环境健康检查通过
19
- - `docs/deployment/deploy-records/<TASK_ID>-YYYYMMDD.md` 证据补齐
8
+ 默认情况下:
9
+ - 小改动直接走 Jenkins 自动构建与自动部署
10
+ - 主要闭环证据写入 `docs/tasks/closure-log.md`
11
+ - 只有需要更重的发布审计时,才补本目录文档
@@ -1,16 +1,25 @@
1
1
  # Review — <Task ID> — YYYY-MM-DD HH:MM
2
2
 
3
- ## 1. 静态分析结果(必须)
4
- - Command:lint + typecheck(来自 docs/ENGINEERING.md frontmatter)
3
+ > 仅在任务需要独立 review 记录时使用;不是每个小改动的默认强制文档。
4
+
5
+ ## 1. 静态分析结果
6
+ - Command:lint / typecheck / script_syntax / diff_check
5
7
  - Summary:
6
8
  - Issues:
7
- - Resolved/Deferred(deferred 必须给出后续任务):
8
9
 
9
- ## 2. 代码质量
10
- ## 3. 本地构建与测试质量(后端 test + 前端 build/lint/typecheck)
11
- ## 4. 本地 Compose 验证(health / smoke / regression)
12
- ## 5. 接口契约(API Markdown + change-log)
13
- ## 6. Jenkins 准备度(Jenkinsfile / job config / image strategy)
14
- ## 7. 安全与性能
15
- ## 8. 风险与回滚
16
- ## 9. 结论(Pass / Blocked)
10
+ ## 2. 本地轻量校验
11
+ - build
12
+ - test or quick_test:
13
+ - api docs:
14
+ - jenkinsfile / scripts:
15
+
16
+ ## 3. 按需本地运行验证(如果有)
17
+ - runtime-up / health / smoke / regression:
18
+
19
+ ## 4. Jenkins 与目标环境
20
+ - Jenkins readiness:
21
+ - Target env verification:
22
+
23
+ ## 5. 风险与结论
24
+ - Risk:
25
+ - Conclusion:Pass / Blocked
@@ -0,0 +1,24 @@
1
+ # Closure Log(默认轻量闭环记录:每个任务至少一条)
2
+
3
+ 规则:
4
+ 1) 每个任务完成后,至少追加一条闭环记录
5
+ 2) 默认记录真实提交、Jenkins、目标环境验证结果
6
+ 3) Jenkins 失败后再修复的任务,应补充失败原因和修复提交
7
+ 4) 这里是默认闭环文档;长 summary 只用于高风险或复盘任务
8
+
9
+ ---
10
+
11
+ ## <TASK_ID> — <Title> — YYYY-MM-DD HH:MM
12
+ - Task: <TASK_ID>
13
+ - Commit: <commit sha>
14
+ - Jenkins Build: <build url>
15
+ - Target Env: <env name / health url / page path>
16
+ - Verification: <health / key api / key page / business path>
17
+ - Result: PASS / FAIL / PARTIAL
18
+ - Follow-up: <none or todo>
19
+ - Jenkins Failure: <optional>
20
+ - Fix Commit: <optional>
21
+
22
+ ---
23
+
24
+ 继续在下方追加记录(不要删除历史记录)
@@ -1,5 +1,7 @@
1
1
  # Task Summary — <TASK_ID> — <Title>
2
2
 
3
+ > 仅用于高风险、跨模块、阶段性里程碑、需要完整复盘的任务。
4
+
3
5
  - Task ID:<TASK_ID>
4
6
  - Date:YYYY-MM-DD
5
7
  - Scope(本次范围):
@@ -9,47 +11,22 @@
9
11
 
10
12
  ## 1. 目标与验收结论
11
13
  - 目标:
12
- - 验收结论:PASS / FAIL(FAIL 必须说明原因与后续计划)
14
+ - 验收结论:PASS / FAIL
13
15
 
14
- ## 2. 变更概览(代码/配置/本地运行/Jenkins)
16
+ ## 2. 变更概览
15
17
  - 关键改动点:
16
18
  - 影响模块:
17
- - 兼容性影响(是否破坏兼容、迁移方案):
18
-
19
- ## 3. 接口变更(以 API Markdown 为准)
20
- - 新增:
21
- - 修改:
22
- - 废弃:
23
- - 变更记录位置:`docs/interfaces/api-change-log.md`(对应条目)
19
+ - 兼容性影响:
24
20
 
25
- ## 4. 数据变更(如有)
26
- - 表/字段变更:
27
- - 迁移方式:
28
- - 回滚方式:
21
+ ## 3. 质量证据
22
+ - 本地轻量校验:build / test or quick_test / lint / typecheck / api docs / jenkinsfile / diff-check
23
+ - Jenkins Build:
24
+ - 目标环境验证:
25
+ - 闭环记录:`docs/tasks/closure-log.md`
29
26
 
30
- ## 5. 质量门禁证据(必须可追溯)
31
- - 项目配置:`docs/ENGINEERING.md`(frontmatter)
32
- - 后端测试:`commands.test`
33
- - 前端构建:`commands.build`
34
- - 静态分析:`commands.lint`
35
- - 前端类型检查:`commands.typecheck`
36
- - Review 文档:`docs/reviews/<TASK_ID>-<timestamp>.md`
37
- - API 文档:`docs/interfaces/api.md`
38
- - Jenkins 配置检查:`Jenkinsfile` + `jenkins.*`
39
- - 回归矩阵:`docs/testing/regression-matrix.md`(全量 PASS,0 fail,且每项必须有真实证据)
40
-
41
- ## 6. Bug 清单与回归用例
42
- - 新增/确认的 Bug(写入 `docs/bugs/bug-list.md`):
43
- - 新增自动化回归用例(引用回归矩阵ID):
44
-
45
- ## 7. 本地运行与 Jenkins 部署记录
46
- - 本地 Compose 验证:health / smoke / regression 结果
47
- - Jenkins 部署记录:`docs/deployment/deploy-records/<TASK_ID>-YYYYMMDD.md`
48
- - Docker compose / image / Jenkins Job 变更(若有):
49
-
50
- ## 8. 风险与回滚
27
+ ## 4. 风险与回滚
51
28
  - 风险:
52
- - 回滚点(备份/回滚步骤):
29
+ - 回滚方式:
53
30
 
54
- ## 9. 后续行动(如有)
31
+ ## 5. 后续行动
55
32
  - TODO:
@@ -1,34 +1,41 @@
1
- # Taskbook(任务本:持续续写,权威任务来源)
1
+ # Taskbook(任务本:持续续写,默认权威任务来源)
2
2
 
3
3
  规则:
4
- 1) 所有任务都写在本文件(持续续写,不另起任务文件)
5
- 2) 允许拆子任务:每个子任务也必须走全流程(DD→实现→测试→review→接口文档→本地 Compose 验证→回归→总结→commit→push→Jenkins 验证)
6
- 3) 每个任务必须有明确验收与证据(日志/报告/文件路径)
4
+ 1) 所有任务都写在本文件(持续续写,不另起零散任务文件)
5
+ 2) 普通小改动只要求最小设计记录;跨模块、接口、数据库、部署、Jenkins、关键页面流程变更才补 DD
6
+ 3) 每个任务最终必须有闭环证据:提交、Jenkins、目标环境验证、结果、遗留问题
7
+ 4) 长 summary 不是默认强制产物;只有高风险或需要完整复盘时再补
7
8
 
8
9
  ---
9
10
 
10
11
  ## Task T0001 — <Title>
11
- - 状态:Planned | Designing | Implementing | Testing | Reviewing | Runtime Verifying | Pipeline Verifying | Done
12
+ - 状态:Planned | Designing | Implementing | Local Checking | Pipeline Verifying | Target Verifying | Done | Blocked
12
13
  - 范围(In scope):
13
14
  - 非目标(Out of scope):
14
- - 验收标准(必须可执行):
15
- - 依赖/约束:
16
- - 子任务:
15
+ - 是否高风险(Yes/No):
16
+ - 高风险分类(如有):DB / Auth / Payment / Jenkins / Gateway / Upload / Prod Config
17
+ - 影响面(API / DB / Jenkins / Page / Config / Deploy):
18
+ - 最小设计记录:
19
+ - 验收标准:
20
+ - 子任务(如有):
17
21
  - [ ] T0001-1 <subtask>
18
- - [ ] T0001-2 <subtask>
19
22
 
20
- ### 证据(完成后填写)
21
- - 项目配置:`docs/ENGINEERING.md`(frontmatter)
23
+ ### 默认证据(完成后填写)
24
+ - 项目配置:`docs/ENGINEERING.md`
25
+ - 提交:<commit sha>
26
+ - Jenkins Build:<build url>
27
+ - 目标环境验证:<health/api/page/business path>
28
+ - 闭环记录:`docs/tasks/closure-log.md`
29
+
30
+ ### 按需补充证据(仅在需要时填写)
22
31
  - DD:`docs/design/T0001-<slug>.md`
23
32
  - Review:`docs/reviews/T0001-YYYYMMDD-HHMM.md`
24
33
  - API 文档:`docs/interfaces/api.md`
25
34
  - API Change Log:`docs/interfaces/api-change-log.md`
26
- - 本地CI:粘贴摘要或给出文件路径
27
- - 本地 Compose 验证:命令输出或 Review 文档摘要
28
- - Jenkins 部署记录:`docs/deployment/deploy-records/T0001-YYYYMMDD.md`
29
- - 回归矩阵:`docs/testing/regression-matrix.md`(全量PASS,且每项必须有真实证据)
30
- - Bug清单(如有):`docs/bugs/bug-list.md`
31
- - 任务总结(强制):`docs/tasks/summaries/T0001.md`
35
+ - 回归矩阵:`docs/testing/regression-matrix.md`
36
+ - Bug 清单:`docs/bugs/bug-list.md`
37
+ - Task Summary:`docs/tasks/summaries/T0001.md`
38
+ - Deployment Record:`docs/deployment/deploy-records/T0001-YYYYMMDD.md`
32
39
 
33
40
  ---
34
41
 
@@ -1,11 +1,11 @@
1
- # Regression Matrix(本地 Compose 环境回归矩阵:必须全量 PASS,0 fail)
1
+ # Regression Matrix(按需回归记录,不是每个小改动的默认门禁)
2
2
 
3
- > 1. 仅记录当前真实实现,不要预填伪接口或目标态接口。
3
+ > 1. 只记录真实执行过的回归项。
4
4
  > 2. `Status` 允许值:`TODO` / `PASS` / `FAIL`。
5
- > 3. 新增或未执行项默认填写 `TODO`,不得预填 `PASS`。
6
- > 4. `PASS` 只允许在真实执行后填写,且 `Evidence` 不得保留占位符。
7
- > 5. `python3 docs/tools/autopipeline/ap.py check-matrix` 会把非 `PASS` 行和占位符证据视为未完成。
5
+ > 3. 未执行项保持 `TODO`,不得预填 `PASS`。
6
+ > 4. 只有真实执行并具备证据时,才允许填写 `PASS`。
7
+ > 5. `check-matrix` 只在显式要求完整回归时使用,不作为默认小改动门禁。
8
8
 
9
9
  | ID | Area | Endpoint/Feature | Test Type | Steps / Command | Expected | Status(TODO/PASS/FAIL) | Evidence |
10
10
  |---|---|---|---|---|---|---|---|
11
- | R-001 | API | <Endpoint or feature> | <smoke/regression/manual> | <command or manual steps> | <expected result> | TODO | <fill-with-log-path-screenshot-or-report> |
11
+ | R-001 | <Area> | <Endpoint or feature> | <manual/smoke/regression> | <command or manual steps> | <expected result> | TODO | <real log path / screenshot / report> |