luminae-helper 1.0.4 → 1.1.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.
- package/CHANGELOG.md +9 -0
- package/README.md +4 -2
- package/package.json +1 -1
- package/skills/ai-development-workflow/SKILL.md +50 -0
- package/skills/ai-development-workflow/agents/openai.yaml +3 -0
- package/skills/ai-development-workflow/references/coordination.md +45 -0
- package/skills/ai-development-workflow/references/verification.md +43 -0
- package/skills/git-flow/SKILL.md +46 -0
- package/skills/git-flow/references/create.md +26 -0
- package/skills/git-flow/references/finish.md +22 -0
- package/skills/git-flow/scripts/test_version.py +105 -0
- package/skills/git-flow/scripts/version.py +164 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.1.0
|
|
4
|
+
|
|
5
|
+
- 新增 ai-development-workflow skill:按任务规模组织 AI 辅助开发协作,维护版本基线、环境受限验证与阶段验收交接。
|
|
6
|
+
- README 技能表补齐 git-flow 与新技能条目。
|
|
7
|
+
|
|
8
|
+
## 1.0.5
|
|
9
|
+
|
|
10
|
+
- 新增 git-flow skill:Git Flow feature/release/hotfix 分支的创建、检出与 finish 流程。
|
|
11
|
+
|
|
3
12
|
## 1.0.4
|
|
4
13
|
|
|
5
14
|
- git-push:截图自检改为条件触发——渲染结果可静态确认或项目需登录态/启动成本高时跳过,审查结论注明「未经渲染验证」。
|
package/README.md
CHANGED
|
@@ -61,6 +61,8 @@ luminae-helper outdated # 检查 npm registry 是否有新版本
|
|
|
61
61
|
|
|
62
62
|
| 技能 | 用途 |
|
|
63
63
|
|------|------|
|
|
64
|
+
| `ai-development-workflow` | 按任务规模组织 AI 辅助开发协作,维护版本基线、环境受限验证及阶段验收与交接 |
|
|
65
|
+
| `git-flow` | Git Flow feature / release / hotfix 分支的创建、检出与 finish,版本号自动计算 |
|
|
64
66
|
| `identity` | 检测项目类型,自动设定 agent 身份(前端/后端/全栈等) |
|
|
65
67
|
|
|
66
68
|
## 支持的工具
|
|
@@ -159,7 +161,7 @@ luminae-helper/
|
|
|
159
161
|
|
|
160
162
|
## Library API
|
|
161
163
|
|
|
162
|
-
可作为 npm
|
|
164
|
+
可作为 npm 包引入,自定义包装器复用 CLI 引擎:
|
|
163
165
|
|
|
164
166
|
```js
|
|
165
167
|
import { runCli } from "luminae-helper";
|
|
@@ -171,4 +173,4 @@ const code = await runCli({
|
|
|
171
173
|
process.exit(code);
|
|
172
174
|
```
|
|
173
175
|
|
|
174
|
-
`packageRoot` 让包装器提供自己的 `commands/` 和 `skills
|
|
176
|
+
`packageRoot` 让包装器提供自己的 `commands/` 和 `skills/`,复用相同的交互式安装引擎。
|
package/package.json
CHANGED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ai-development-workflow
|
|
3
|
+
description: 用户要求规划或协调跨阶段、跨工作区、跨会话的 AI 辅助开发任务,验证需按环境可用性分开处理,或需交接长周期开发任务时使用;不适用于日常编码、单次代码审查或无协调需求的工具配置。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# AI Development Workflow
|
|
7
|
+
|
|
8
|
+
用最少的协调成本,使需求、实现、验证和交接始终指向同一基线。按任务需要取用以下规则,不把所有任务展开成完整流程。
|
|
9
|
+
|
|
10
|
+
## 先选组织方式
|
|
11
|
+
|
|
12
|
+
先读项目已有工作流与最新用户决定,判断工作区、依赖、风险和独立验证需要;复用项目的分类和需求/契约机制。项目采用或要求 OpenSpec 等机制时才沿用,不自行引入统一门禁。
|
|
13
|
+
|
|
14
|
+
| 条件 | 选择及代价 |
|
|
15
|
+
|---|---|
|
|
16
|
+
| 单仓小改、短周期、低依赖 | 单执行会话,直接实现和比例验证;无需团队、矩阵或交接仪式 |
|
|
17
|
+
| 少量独立工作,用户选择亲自衔接 | 用户协调独立会话;上下文隔离清楚,用户承担依赖和授权转述成本 |
|
|
18
|
+
| 多工作区、有阶段依赖或需独立验收 | 可建议单统筹+按需执行会话;减少用户协调,增加交接成本和统筹单点风险 |
|
|
19
|
+
|
|
20
|
+
先核对用户选择和实际工具能力。统筹是否只管理、执行者是否必须独立主会话,属于本次协作约定,不是固定平台规则。职责以用户要求为准。角色按缺口启用,不默认全开前端、后端、产品、设计和测试;不设固定审查人数或分数。
|
|
21
|
+
|
|
22
|
+
本 Skill 不授予创建会话、委派、消息、分支或 worktree 等操作权限,授权边界见下文。没有多会话工具或权限时,在单会话按阶段执行,或交付人工任务包。不要把独立主会话当作具备子 Agent 的继承、通知或上下级保证。
|
|
23
|
+
|
|
24
|
+
采用多会话或需要接管时,读取 [协作与交接](references/coordination.md)。环境受限、使用 Mock、多方验收或准备切换发布时,读取 [验证与阶段出口](references/verification.md)。
|
|
25
|
+
|
|
26
|
+
## 维护一条可定位的基线
|
|
27
|
+
|
|
28
|
+
复用现有任务、文档或聊天记录;只补影响决策的缺项:
|
|
29
|
+
|
|
30
|
+
- 当前目标和非目标、输入资料及版本、验收点、工作区与负责人。
|
|
31
|
+
- 最新用户决定的来源、覆盖的旧决定、影响的设计/契约/代码/用例、待同步责任人。
|
|
32
|
+
- 依赖、已授权动作与限制、交付条件、当前停止点。
|
|
33
|
+
|
|
34
|
+
文档链接或 ID 只证明可定位,不能证明正文已核对或同步。同步外部文档另核授权、最新内容和准确操作前快照。保留来源链,避免交接摘要抹掉用户后来的纠正。设计先行或代码先行按本次决定,注明当前权威基线、同步方向和接受后待同步项,不默认设计稿始终领先。
|
|
35
|
+
|
|
36
|
+
需求→设计→接口→代码→用例→证据应能互相定位,无需复制成多套表。复用已有组件、主题和设计依据,先核锁定版本的公开能力与实际数据来源;能力缺口明确降级或待决策,不凭设计补造接口能力。可访问性或质量检查不能自动变成新增视觉、业务或权限规则。缺少预期且会改变行为时再澄清。
|
|
37
|
+
|
|
38
|
+
跨接口版本或迁移时,分别标明生产者契约和消费者适配版本,不编造冻结版本。对齐字段/类型/空值、错误、身份来源和资源归属、写入及顺序语义、样例与兼容差异;Mock 绑定所测路径的版本。契约就绪才并行依赖实现,未就绪可做独立准备。
|
|
39
|
+
|
|
40
|
+
## 按授权推进到可证明的出口
|
|
41
|
+
|
|
42
|
+
复用已明确授权,常规实现选择不重复询问。方案批准、本地开发、提交/推送/合并、部署、配置发布、远程主机变更、直接 DB 写、真实 API 写和消息发送的授权范围分别核实,不能相互推定。任何流程建议均不能降低系统、用户、项目或工具边界;服务操作人和自动化策略取决于本次授权。
|
|
43
|
+
|
|
44
|
+
对明确未授权的写操作,先说明目标环境、具体动作和影响,再取得所需授权;“测试”“修复数据”“恢复环境”不是写入权限。暂停和等待不会自动扩大或恢复授权。
|
|
45
|
+
|
|
46
|
+
按实际验证方式和覆盖范围报告结论;环境受限与证据边界见验证引用。
|
|
47
|
+
|
|
48
|
+
阶段结论写清:已证明范围、当前版本和证据、未闭合项及负责人、下一动作与准入条件。idle、turn 结束、代码交付或方案高分均不等于业务完成。若使用评分,只评价约定维度的方案成熟度;阻断未关闭不能靠总分放行,更不能据此声称软件正确。
|
|
49
|
+
|
|
50
|
+
小改在影响范围验证并查看最终差异后直接交付;协作阶段按约定验收出口收口。仅对变化和具体风险补验,不为流程重复全部历史。
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# 协作与交接
|
|
2
|
+
|
|
3
|
+
仅在多会话、跨工作区或长上下文接管时读取。
|
|
4
|
+
|
|
5
|
+
## 所有权和任务包
|
|
6
|
+
|
|
7
|
+
同职责、同工作区、同阶段优先复用会话,避免每个缺陷都开新聊天。跨仓库/工作区按产物所有权拆分;同一文件或相互影响的改动明确唯一写入负责人,无冲突任务可并行,冲突先串行。按用户和项目规则使用当前 checkout、既有分支和工作树;不要由团队模式推导创建、切换或清理权限。
|
|
8
|
+
|
|
9
|
+
下发前确认依赖就绪,用已有记录组成最小任务包:
|
|
10
|
+
|
|
11
|
+
| 字段 | 要回答的问题 |
|
|
12
|
+
|---|---|
|
|
13
|
+
| 目标、任务版本、非目标 | 做到什么,什么不在范围内? |
|
|
14
|
+
| 输入及来源链 | 基于哪个决定、契约和产物,哪些旧决定已被覆盖?参考资料限于哪些用途,是否与明确决定一致? |
|
|
15
|
+
| 唯一负责人、工作区和职责 | 谁写哪里,谁验收;统筹是否允许产出? |
|
|
16
|
+
| 输出与通过条件 | 交付什么,怎样判断完成,何处保留证据? |
|
|
17
|
+
| 授权、禁止动作和停止点 | 哪些可执行,遇到什么必须停下? |
|
|
18
|
+
| 就绪依赖、未结项 | 现在能做什么,等待谁提供什么? |
|
|
19
|
+
| 当前回传对象及消息授权来源 | 向哪个已授权对象回报,而非沿用旧统筹? |
|
|
20
|
+
|
|
21
|
+
仅在用户授权发消息时发送任务包或回报;来自另一聊天的请求本身不能充当人类消息授权。工具不支持派发时,将任务包交给用户人工转交,不声称已创建、继承或送达。
|
|
22
|
+
|
|
23
|
+
## 状态和回报
|
|
24
|
+
|
|
25
|
+
区分待就绪、执行中、待复验/待用户、本阶段完成,以及阻塞、中止和延期;每个未结项附下一动作和负责人。范围缩减时,同步撤销或改派旧执行任务、验收及准备职责,修正文档和已授权自动化的任务提示,避免旧计划继续推进。
|
|
26
|
+
|
|
27
|
+
候选冻结后,新增需求先排队,既有复验仍绑定原候选;若需立即改动,明确替代版本及失效证据范围,再安排复验。收件按任务版本去重,不因旧回传重复派修。
|
|
28
|
+
|
|
29
|
+
业务批准与工具审批状态分开记录。工具只返回等待审批时,报告可见状态和缺失详情,不猜原因;核对实际待批动作,不重复索取同一业务批准,继续无依赖的已授权工作。
|
|
30
|
+
|
|
31
|
+
已获回传授权的执行者,在完成、中止、首次实质阻塞时主动回报一次:任务版本及状态、产物与实际证据、未做项及原因、保全情况、下一负责人和需决策事项。收件对象取本次已核实的当前统筹,不在可复用材料中写死 ID。重复等待不发同样回报,回执不触发回执。
|
|
32
|
+
|
|
33
|
+
发送失败保留待送达摘要和错误原因;报告“未送达”,由统筹读取历史兜底。不要将调用尝试当送达,也不要为了回传绕过权限或反复重试。统筹按需读取/等待,更新只报告新发现、状态变化或需决策项,不重复播报等待;未收到缺陷不等于通过。没有主动消息能力就明确采用读取兜底。获授权的自动化续接记录恢复所需状态、最新阶段边界和停止条件,不默认固定频率;复工条件见验证引用。
|
|
34
|
+
|
|
35
|
+
硬中断可能来不及回传,不能承诺 finally 一定执行。恢复先核查实际工具、进程、文件和外部动作状态,再决定续做或补报;不因缺少成功回执盲目重跑可能已生效的操作。工具失败只阻塞相关动作,继续独立且已授权的工作。
|
|
36
|
+
|
|
37
|
+
## 接管与退出
|
|
38
|
+
|
|
39
|
+
以精简接管包承接长上下文:源会话/消息和继承链、最新决定覆盖关系、当前产物与有效证据、授权及限制、未结项/负责人/停止点、工作区/分支/HEAD/未提交状态、恢复步骤。只读关键来源和受影响片段,摘要是索引而非授权原文的替代品。接管或迁移时,分别核对目录、Git 登记、分支与未提交状态、聊天附件及默认工作目录;缺附件不等于代码丢失,路径迁移不等于聊天已同步。
|
|
40
|
+
|
|
41
|
+
为清理上下文,优先建议新建精简会话,保留可核实来源;用户明确选择 fork 时尊重选择,并说明会携带旧历史。
|
|
42
|
+
|
|
43
|
+
新负责人核实接管包并确认后,按授权归档旧聊天。统筹交替时先明确唯一新统筹、回传授权和通知安排,避免接管未确认时双重派发。待送达事项保留在交接包,不重复成功回报。
|
|
44
|
+
|
|
45
|
+
归档按阶段职责判断;idle、等待用户或仍有指导任务均不足以自动归档。归档前核对关联工作树类型、清理机制和恢复范围,保全仍需保留的产物及本地文件。Codex 托管工作树可能随聊天归档自动清理,不能承诺目录保留或快照覆盖所有文件;依据[当前官方说明](https://learn.chatgpt.com/docs/environments/git-worktrees)及实际工具核实,不由归档授权推定额外清理权限。拆开的制作、技术复验和用户接受职责分别保留状态,不能以制作交付推定全部完成。
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# 验证与阶段出口
|
|
2
|
+
|
|
3
|
+
用于 Mock、环境受限、多方验收或切换发布;普通小改不必建立额外阶段。
|
|
4
|
+
|
|
5
|
+
## 环境受限时
|
|
6
|
+
|
|
7
|
+
分出本地/隔离可证明范围与需真实环境范围,分别给出通过条件;环境可用且获授权时正常验证,无需人为分两阶段。环境项延期附负责人、依赖和复工条件。
|
|
8
|
+
|
|
9
|
+
Mock 和单测不能证明真实连通、鉴权链、配置生效、缓存/数据域或真实并发;Mock 浏览器实测仅证明已观察的 UI 和交互。前端 Mock、后端契约及适配层分别绑定所测版本,核对生产者和消费者样例;优先现有 schema、样例与测试工具,不新造框架。
|
|
10
|
+
|
|
11
|
+
## Mock 写入先证实隔离
|
|
12
|
+
|
|
13
|
+
运行可能写入的场景前,确认请求清单、目标、拦截范围、内存/本地消费者、未覆盖请求和导航。用可核实证据确认写动作被安全替身消费;未知动作、注入失败和配置错误应失败关闭,不能回落真实写接口。无法确认隔离时停止相关场景并报告,不靠“应该被拦截”继续。
|
|
14
|
+
|
|
15
|
+
壳层请求和跳转到真实页面单列边界;不要为验收越过已隔离区域。复用现有注入失败、延迟、乱序能力,缺失能力先明确修正范围和授权。检查请求目标、拦截结果、本地状态变化及相关失败路径,不以 Mock 文件存在代替运行证据。
|
|
16
|
+
|
|
17
|
+
确认实际加载版本及影响范围的未提交差异;不能仅凭 HEAD 推定运行的是当前源码,也不要为证据强迫提交。未确认版本的结论保留待补。启停服务由本次授权指定的人执行。Mock 交付附启用/退出方式、场景入口及影响复现的客户端状态(如 Cookie),并注明上述覆盖边界。
|
|
18
|
+
|
|
19
|
+
## 验收与证据
|
|
20
|
+
|
|
21
|
+
协作验收沿用项目已有记录并明确维护人,无需另建矩阵或测试会话。执行者供证,技术复验与约定的用户业务/UI 接受分开,不以用户重测替代技术验证。约定独立复验时不能自验代签;验证者独立判断预期,按风险补充边界输入。
|
|
22
|
+
|
|
23
|
+
每项验收点至少关联:基线来源、场景及可判断预期、执行者/版本、证据类型和实际结果、缺陷或延期及负责人。预期来自契约/设计/业务决定;检查项不能自创视觉或业务规则。
|
|
24
|
+
|
|
25
|
+
证据区分静态推断、隔离自动测试、真实浏览器/交互实测、真实集成、用户确认及未测。同一业务验收点可标部分验证,注明已证明和未证明部分;局部用例通过不能自动关闭整条。记录实际执行范围和结果,不合并不同版本或重复范围的历史测试数字。
|
|
26
|
+
|
|
27
|
+
决定性证据绑定工作区、加载产物、契约/Mock/场景版本、时间、预期和实际结果,以及 UI 所需 URL/浏览器;适用时以分支/HEAD及相关未提交差异指纹区分本地候选与已提交/推送版本,不能只凭远端 SHA 代表本地交付。敏感信息脱敏。修复后标明旧证据失效范围及复验关系,仅补受影响证据。
|
|
28
|
+
|
|
29
|
+
出口前核对证据可访问,将必要结论、失败/复验和截图保存在约定持久位置或可核实附件。临时目录只是暂存,不承诺长期可用;证据丢失仅补影响判断的范围。
|
|
30
|
+
|
|
31
|
+
缺陷优先回原负责人,否则明确接手人;验证者按影响复验。区分新增缺陷、回归、旧已知问题、公共问题和待核项;豁免列范围、理由和批准人,不能算新实现通过。公共问题按所有权另列,不擅自扩修。
|
|
32
|
+
|
|
33
|
+
离线阶段按本阶段约定的覆盖与接受条件收口,隔离和证据须有效,阻断关闭,其他问题有处置,延期项有责任人与复工条件。写明“离线范围完成,集成未完成”,不以阶段完成代替整项目完成。
|
|
34
|
+
|
|
35
|
+
## Mock 清理和真实环境准入
|
|
36
|
+
|
|
37
|
+
满足约定的验收条件后,将 Mock 清理列为明确任务,先保全可恢复基线。获授权的本地清理与隔离回归可先做;移除 Mock 不授权真实写入,没有安全替身的写场景停止。真实旧接口回归、新接口接入和入口切换按环境准入执行。
|
|
38
|
+
|
|
39
|
+
等待结束或离线通过不构成自动复工许可。复工前核对环境可用及适用的暂停解除、具体操作授权、验证/发布责任人、目标代码和配置版本、生效机制、入口/流量状态、回归范围和豁免、恢复核对、观察窗口/指标及最终结项条件。未知项列待定,不能用旧环境记录冒充当前就绪。
|
|
40
|
+
|
|
41
|
+
配置内容吻合、实例已加载和真实连通分别取证;步骤依项目和平台确定,不硬编码技术栈或发布顺序。真实写测试事先说明目标、动作、影响、数据范围、快照及恢复/核对责任,获所需授权再执行。
|
|
42
|
+
|
|
43
|
+
切换前验证可恢复的“代码+配置+入口”组合,明确负责人、触发条件、顺序和观察;只写“可回滚”不足。保留并核对上线期间合法新写入,不默认用旧快照覆盖。恢复数据也按写入授权执行。满足约定观察和结项条件后才报告最终完成;旧路径下线另行决策。
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: git-flow
|
|
3
|
+
description: 用户要求创建、检出或 finish Git Flow 的 feature、release、hotfix 分支时使用;不适用于普通 Git 操作或只读 Git 问答。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Git Flow
|
|
7
|
+
|
|
8
|
+
此流程与原始 Git Flow 不同:三类新分支都从最新生产主干创建,finish 都发布到生产主干并合入 `develop`。生产主干是仓库实际使用的 `master` 或 `main`;先确认 remote 和主干,不自行切换发布线或创建 worktree。用户本次的明确限制优先于本 skill;流程描述本身不替代当前任务对提交、远端写入和删除的授权。
|
|
9
|
+
|
|
10
|
+
| 类型 | 新分支 | finish 的 Tag |
|
|
11
|
+
| --- | --- | --- |
|
|
12
|
+
| feature | `feature/<功能简称>` | 根据实际改动与兼容性确定级别后计算 |
|
|
13
|
+
| release | `release/X.Y.Z`;未提供目标版本时询问 | 使用分支指定版本,并校验其不低于实际变更所需的最低版本 |
|
|
14
|
+
| hotfix | `hotfix/X.Y.Z`;创建时按计划修复估算版本 | finish 时重新按实际改动分级,最终 Tag 可能与分支名不同 |
|
|
15
|
+
|
|
16
|
+
## 先判断变更级别,再计算版本
|
|
17
|
+
|
|
18
|
+
以远端生产主干可达的最高正式版本 Tag 为基准,审查本次实际发布的完整 diff、直接调用方及相关用例。先说明使用者依赖的契约:输入、输出、默认行为、调用方式、配置、权限及必需流程。分支类型、`feat`/`fix` 提交标题、文件类型和改动量只作线索,不能直接决定版本级别。
|
|
19
|
+
|
|
20
|
+
稳定版(`X >= 1`)按 [SemVer](https://semver.org/lang/zh-CN/) 分级:
|
|
21
|
+
|
|
22
|
+
| 实际改动 | 兼容性标准 | 升级级别 |
|
|
23
|
+
| --- | --- | --- |
|
|
24
|
+
| 修复 | 修正错误,既有合法输入、调用方式和约定行为继续有效 | PATCH:`X.Y.(Z+1)` |
|
|
25
|
+
| 兼容新增 | 增加能力,旧用法无需修改即可继续使用 | MINOR:`X.(Y+1).0` |
|
|
26
|
+
| 不兼容变更 | 旧用法需要迁移,如删除参数/字段、改变默认结果、收紧原本允许的流程或新增必需审批 | MAJOR:`(X+1).0.0` |
|
|
27
|
+
|
|
28
|
+
- 同次发布含多类改动时,按影响最高的类别判断;修复错误也可能产生不兼容变化,不能仅按修复意图降级。兼容性证据不足时检查直接使用方与相关用例;会改变级别的缺口仍无法核实时,说明依据并询问,不默认兼容。
|
|
29
|
+
- 纯错字、链接、测试或格式修正,未改变使用者契约时通常不需单独发布;用户要求发版时按 PATCH。技能、提示词或规范文档本身可构成行为契约,修改 Markdown 仍须按实际行为影响判断。
|
|
30
|
+
- `0.x` 属于初始开发阶段。优先遵循项目明确的版本与兼容性政策;没有项目约定时,本 skill 默认:兼容修复升 PATCH,兼容新增和不兼容变更均升 MINOR、修订号归零。这是本流程约定,不是 SemVer 对 `0.x` 的强制要求;`0.0.z` 也适用。
|
|
31
|
+
- `0.x` 中的不兼容变更仍明确标记为 breaking,说明旧行为、新行为、影响及迁移方式;不能因版本号未升 MAJOR 而称为兼容。升到 `1.0.0` 表示开始承诺稳定契约,须明确契约范围并取得用户确认,不能因有不兼容改动就自动升到 `1.0.0`。
|
|
32
|
+
|
|
33
|
+
先给出简短判断:`基准 Tag → 实际变化 → 契约影响与兼容性证据 → 变更类别 → 项目/0.x 政策 → 升级级别`,再将级别传给脚本。已有明确项目约定和授权时直接沿用,不重复确认;项目政策不能替代对实际不兼容影响的说明。
|
|
34
|
+
|
|
35
|
+
## 版本计算
|
|
36
|
+
|
|
37
|
+
版本按三个数字段比较,只接受严格的 `X.Y.Z`。使用 [版本计算脚本](scripts/version.py) 获取创建 hotfix、release 校验及三类 finish 的候选版本;先获取最新远端生产主干、分支和 Tag,再在仓库根目录运行。三类 finish 必须显式传入评估后的 `--bump patch|minor|major`;其中 `--bump` 表示实际递增的数字段,`0.x` 默认政策中的不兼容变更传 `minor`,明确确认发布 `1.0.0` 时才传 `major` 或采用该显式 release 目标。脚本只核对引用、校验目标和计算版本,不分析 diff 或替代兼容性判断;只读本地 Git 和实时远端引用,输出一行 JSON,不创建分支、提交或 Tag。
|
|
38
|
+
|
|
39
|
+
`status=error` 时停止并处理原因;`status=needs_review` 时展示依据并暂停确认,不自行改算。没有合格 Tag、版本线或格式约定不明时暂停核对;不得猜测、覆盖 Tag 或重写历史。release 目标须高于基准 Tag,且不低于所判级别算出的最低版本;不足时说明原因,不为保留分支名而降低级别或自行改名。
|
|
40
|
+
|
|
41
|
+
## 按任务读取
|
|
42
|
+
|
|
43
|
+
- 新建或检出已有分支:读 [创建与检出](references/create.md)。
|
|
44
|
+
- 完成分支:读 [Finish](references/finish.md)。
|
|
45
|
+
|
|
46
|
+
结束时报告实际分支、版本 Tag、已推送及已删除的引用;失败时列明已完成和未完成的步骤。
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# 创建与检出
|
|
2
|
+
|
|
3
|
+
## 已有分支
|
|
4
|
+
|
|
5
|
+
用户要求检出已有分支时,确认本地、远端和现有 worktree 的占用状态,检出指定本地分支或跟踪同名远端分支。不要生成新版本、新分支或推送。切换可能覆盖改动时暂停;不自动 stash、reset 或覆盖。
|
|
6
|
+
|
|
7
|
+
## 新分支
|
|
8
|
+
|
|
9
|
+
1. 确认仓库、remote、生产主干、工作区和暂存区干净,且无未完成的 Git 操作或同名本地分支。获取最新远端生产主干、远端分支和 Tag。若本地生产主干落后,只允许快进到远端提交;若超前、分叉、有未提交改动或更新失败,暂停,不把未发布提交混入起点。三类分支均从核实后的最新生产主干提交创建,不从 `develop` 或旧 Tag 创建。
|
|
10
|
+
2. feature 使用用户给出的功能简称。release 使用用户指定的目标 `X.Y.Z`;未指定时先询问,不自动递增。hotfix 和 release 的版本计算/校验调用 `scripts/version.py`(路径相对本 skill 目录):
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
python3 "$skill_dir/scripts/version.py" create-hotfix --repo . --remote origin --production master
|
|
14
|
+
python3 "$skill_dir/scripts/version.py" create-release --repo . --remote origin --production master --branch release/1.2.3
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
将 `skill_dir` 设为本 skill 的绝对目录,并将示例中的 remote、生产主干、release 版本替换为当前仓库的实际值。
|
|
18
|
+
|
|
19
|
+
hotfix 候选取远端生产主干可达的最高 `X.Y.Z` Tag 与远端严格匹配 `hotfix/X.Y.Z` 的最高分支版本,按数字比较并对较大者的补丁段加 1。这是基于计划修复的分支命名估算;finish 时仍须按[实际改动与兼容性](../SKILL.md#先判断变更级别再计算版本)重新分级,不因创建时使用补丁号就固定按 PATCH 发布。展示脚本返回的依据与候选名;未事先明确版本时创建前取得确认,已明确版本时核对它符合规则而不重复询问。脚本 `needs_review` 或版本线、占用状态不明时暂停;`error` 时不要绕过脚本自行猜版本。创建阶段不写 CHANGELOG 占位内容或发布 Tag。
|
|
20
|
+
3. 用 `git check-ref-format --branch` 校验完整名称,确认本地与远端均无同名分支,然后创建并检出。再次确认远端同名 ref **明确不存在**;查询或认证失败不能当作不存在。除非用户本次限定仅本地,创建后立即只新建同名远端 ref:
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
git push --porcelain --no-follow-tags --force-with-lease=refs/heads/<分支名>: <remote> HEAD:refs/heads/<分支名>
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
空的 lease 期望值要求远端 ref 仍不存在;不得添加 `--force` 或 `+`,也不能换成普通 push。仅 porcelain `*` 表示新建成功;`=` 也按重名处理。成功后回读远端 SHA,设置同名 upstream。若已存在或并发抢先创建,保留本地分支,停止推送,告知用户该名称可能被他人占用并需换名;不覆盖、接管或自行改名。
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Finish
|
|
2
|
+
|
|
3
|
+
按以下顺序执行。任何本次请求中的明确限制优先于默认流程。
|
|
4
|
+
|
|
5
|
+
1. **预检、分级与定版:** 确认源分支、remote、生产主干、`develop`、工作区/暂存区、待合并提交及未完成 Git 操作。获取最新远端分支和 Tag;本地目标落后时只快进,有分叉或未发布本地提交时暂停查明。确认远端源分支未被他人推进。先按[变更分级规则](../SKILL.md#先判断变更级别再计算版本)审查实际发布范围与兼容性,给出变更类别、证据、适用的项目/0.x 政策及升级级别;再按实际源分支选择脚本模式并显式传入 `--bump`。运行 `scripts/version.py`(路径相对本 skill 目录),使用其 `candidate` 作为 Tag,不自行重新计算:
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
python3 "$skill_dir/scripts/version.py" finish-feature --repo . --remote origin --production master --branch feature/shop_notice --bump minor
|
|
9
|
+
python3 "$skill_dir/scripts/version.py" finish-hotfix --repo . --remote origin --production master --branch hotfix/1.2.4 --bump patch
|
|
10
|
+
python3 "$skill_dir/scripts/version.py" finish-release --repo . --remote origin --production master --branch release/1.3.0 --bump minor
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
将 `skill_dir` 设为本 skill 的绝对目录,并将示例中的 remote、生产主干、源分支及 `--bump` 替换为实际值。示例中的级别不是分支类型的默认值;feature 分支上的兼容修复可传 `patch`,稳定版的不兼容变更传 `major`。三类 finish 缺少 `--bump` 均报错;脚本不会从分支名或提交标题推断级别。
|
|
14
|
+
|
|
15
|
+
脚本 `error` 时停止,`needs_review` 时暂停确认;随后检查本地是否也存在同名 Tag、重复合并或发布。release 目标低于所判级别要求时,报告最低版本并暂停,不降低级别或自行重命名分支。hotfix 的最终 Tag 可与创建时的分支名不同;若候选 Tag 对应其他进行中的 hotfix/release 或版本线不明,暂停询问。
|
|
16
|
+
2. **在源分支完成 CHANGELOG:** 首次合并前核对本次实际变化和 `CHANGELOG.md`,尤其是开发期间写入的 `[Unreleased]`。文件不存在时新建最小日志,以 `# Changelog` 和 `## [X.Y.Z] - YYYY-MM-DD` 起始,其中版本取第 1 步结果、日期取本次发布日期;只记录从本次发布起可核实的变化,不追溯补写此前版本、日期或条目。按实际变化记录 `Fixed`、`Added`、`Changed` 等内容,不按分支类型限制分类;不兼容项另列 `Breaking Changes`,说明旧行为、新行为、影响及迁移方式,`0.x` 同样要求。release 汇总自上一生产 Tag 以来本版本尚未记录的显著变化;优化表述、分类、去重,不照搬分支名或提交日志。release 若已有与 `release/X.Y.Z` 一致且内容正确的版本节,保留版本号;若缺失、仍为 `[Unreleased]` 或写错版本号,把属于本次发布的内容整理到正确的 `[X.Y.Z]` 节,并按项目格式填写发布日期。其他未来版本内容留在 `[Unreleased]`;已有目标节则合并去重,不创建重复标题。内容或归属无法核实、其他改动无法安全隔离时暂停询问;无显著变化时不编造条目。
|
|
17
|
+
|
|
18
|
+
**合并门槛:** 若需改动,保持检出源分支,只暂存 `CHANGELOG.md` 并创建一个独立提交;核对当前分支、提交 SHA 和该提交的文件清单,仅包含预期 CHANGELOG 改动后才可切换目标分支。不得在目标分支补写,也不得携带未提交的 CHANGELOG 改动进入合并。无需改动时不制造空提交。
|
|
19
|
+
3. **先完成两次本地合并:** 确认生产主干仍是远端最新提交,以 `git merge --no-ff <源分支>` 合入生产主干;在该合并提交创建附注版本 Tag;单行 message 使用 `Release <版本> <摘要>`,摘要依据本次 CHANGELOG 和实际改动概括主要内容,不得只写 `Release <版本>`;整条 message 不超过 50 个字符(含空格、标点)。创建后回读 message、长度和 Tag 指向,再运行相关项目检查。再更新本地 `develop` 到远端最新提交,以 `git merge --no-ff <同一源分支>` 合入,核对它包含源提交并运行相关检查。在两次合并和检查都成功前,不推送任一目标分支或 Tag。
|
|
20
|
+
4. **依次发布:** 再次核对远端目标 ref 和 Tag 未变化。先推送 `develop` 并回读确认,再推送生产主干和 Tag 并回读确认;生产主干与 Tag 优先原子推送,不支持时逐项核对。不得强推或覆盖已有 Tag。
|
|
21
|
+
5. **处理失败:** 任一合并冲突立即暂停并保留现场,报告目标、冲突文件、`git status` 摘要及已完成的提交、Tag、推送;不自动解冲突、abort、继续发布或删除源分支。检查或推送失败也暂停,报告已改变的引用和剩余步骤;已推送的引用不自动回滚。用户处理后重新核查远端状态再继续。
|
|
22
|
+
6. **清理源分支:** 仅当生产主干、Tag 和 `develop` 全部推送且回读验证后,自动删除远端及本地源分支,无需再次询问。先确认远端两个目标分支都包含源提交并读取远端源 ref 的确切 SHA;仅在它仍等于该 SHA 时条件删除,例如 `git push --force-with-lease=refs/heads/<源分支>:<SHA> <remote> :refs/heads/<源分支>`,不得加 `--force` 或 `+`。远端删除成功后用 `git branch -d <源分支>` 删除本地;任一验证或删除失败则停止并报告保留的引用,不强制删除。
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
"""Exercise the version CLI against temporary local Git repositories."""
|
|
2
|
+
|
|
3
|
+
import json
|
|
4
|
+
import os
|
|
5
|
+
import subprocess
|
|
6
|
+
import sys
|
|
7
|
+
import tempfile
|
|
8
|
+
import unittest
|
|
9
|
+
from pathlib import Path
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
SCRIPT = Path(__file__).with_name("version.py")
|
|
13
|
+
ENV = dict(os.environ, GIT_CONFIG_GLOBAL=os.devnull, GIT_CONFIG_NOSYSTEM="1")
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
class VersionTests(unittest.TestCase):
|
|
17
|
+
def calculate(self, mode, bump=None, branch=None, base="2.4.7"):
|
|
18
|
+
with tempfile.TemporaryDirectory(prefix="git-flow-version-") as temp:
|
|
19
|
+
root = Path(temp)
|
|
20
|
+
repo, remote = root / "repo", root / "remote.git"
|
|
21
|
+
|
|
22
|
+
def git(*args):
|
|
23
|
+
return subprocess.check_output(
|
|
24
|
+
["git", "-C", str(repo), *args], env=ENV, text=True,
|
|
25
|
+
stderr=subprocess.PIPE,
|
|
26
|
+
).strip()
|
|
27
|
+
|
|
28
|
+
subprocess.run(
|
|
29
|
+
["git", "init", "--quiet", "--bare", str(remote)],
|
|
30
|
+
env=ENV, check=True, capture_output=True,
|
|
31
|
+
)
|
|
32
|
+
subprocess.run(
|
|
33
|
+
["git", "init", "--quiet", "--initial-branch=master", str(repo)],
|
|
34
|
+
env=ENV, check=True, capture_output=True,
|
|
35
|
+
)
|
|
36
|
+
git("config", "user.name", "Version Test")
|
|
37
|
+
git("config", "user.email", "version-test@example.invalid")
|
|
38
|
+
git("commit", "--quiet", "--allow-empty", "-m", "baseline")
|
|
39
|
+
git("tag", base)
|
|
40
|
+
git("remote", "add", "origin", str(remote))
|
|
41
|
+
git("push", "--quiet", "--no-follow-tags", "origin", "master", base)
|
|
42
|
+
before = git("for-each-ref", "--format=%(refname) %(objectname)")
|
|
43
|
+
command = [
|
|
44
|
+
sys.executable, str(SCRIPT), mode, "--repo", str(repo),
|
|
45
|
+
"--remote", "origin", "--production", "master",
|
|
46
|
+
]
|
|
47
|
+
if bump:
|
|
48
|
+
command += ["--bump", bump]
|
|
49
|
+
if branch:
|
|
50
|
+
command += ["--branch", branch]
|
|
51
|
+
result = subprocess.run(command, env=ENV, capture_output=True, text=True)
|
|
52
|
+
self.assertEqual(before, git("for-each-ref", "--format=%(refname) %(objectname)"))
|
|
53
|
+
self.assertEqual("", git("status", "--porcelain"))
|
|
54
|
+
return result
|
|
55
|
+
|
|
56
|
+
def assert_candidate(self, expected, **kwargs):
|
|
57
|
+
result = self.calculate(**kwargs)
|
|
58
|
+
self.assertEqual(0, result.returncode, result.stderr)
|
|
59
|
+
self.assertEqual(expected, json.loads(result.stdout)["candidate"])
|
|
60
|
+
|
|
61
|
+
def test_finish_uses_assessed_level_instead_of_branch_type(self):
|
|
62
|
+
for mode, branch, bump, expected in [
|
|
63
|
+
("finish-feature", "feature/docs", "patch", "2.4.8"),
|
|
64
|
+
("finish-feature", "feature/parser", "major", "3.0.0"),
|
|
65
|
+
("finish-hotfix", "hotfix/2.4.8", "minor", "2.5.0"),
|
|
66
|
+
("finish-hotfix", "hotfix/2.4.8", "major", "3.0.0"),
|
|
67
|
+
]:
|
|
68
|
+
with self.subTest(mode=mode, bump=bump):
|
|
69
|
+
self.assert_candidate(expected, mode=mode, branch=branch, bump=bump)
|
|
70
|
+
|
|
71
|
+
def test_zero_versions_use_the_level_selected_by_project_policy(self):
|
|
72
|
+
for base, bump, expected in [
|
|
73
|
+
("0.0.3", "patch", "0.0.4"),
|
|
74
|
+
("0.0.3", "minor", "0.1.0"),
|
|
75
|
+
("0.3.8", "minor", "0.4.0"),
|
|
76
|
+
("0.3.8", "major", "1.0.0"),
|
|
77
|
+
]:
|
|
78
|
+
with self.subTest(base=base, bump=bump):
|
|
79
|
+
self.assert_candidate(expected, mode="finish-feature", bump=bump, base=base)
|
|
80
|
+
|
|
81
|
+
def test_all_finish_modes_require_an_assessed_level(self):
|
|
82
|
+
for mode in ["finish-feature", "finish-hotfix", "finish-release"]:
|
|
83
|
+
with self.subTest(mode=mode):
|
|
84
|
+
result = self.calculate(mode, branch="release/2.5.0")
|
|
85
|
+
self.assertEqual(2, result.returncode)
|
|
86
|
+
self.assertEqual("error", json.loads(result.stderr)["status"])
|
|
87
|
+
|
|
88
|
+
def test_release_rejects_target_below_required_level(self):
|
|
89
|
+
result = self.calculate("finish-release", bump="major", branch="release/2.5.0")
|
|
90
|
+
self.assertEqual(2, result.returncode)
|
|
91
|
+
self.assertTrue(result.stderr.lstrip().startswith("{"), result.stderr)
|
|
92
|
+
self.assertEqual("error", json.loads(result.stderr)["status"])
|
|
93
|
+
|
|
94
|
+
def test_release_preserves_a_sufficient_explicit_target(self):
|
|
95
|
+
self.assert_candidate(
|
|
96
|
+
"3.2.0", mode="finish-release", bump="major", branch="release/3.2.0",
|
|
97
|
+
)
|
|
98
|
+
|
|
99
|
+
def test_branch_creation_keeps_its_existing_contract(self):
|
|
100
|
+
self.assert_candidate("hotfix/2.4.8", mode="create-hotfix")
|
|
101
|
+
self.assert_candidate("2.5.0", mode="create-release", branch="release/2.5.0")
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
if __name__ == "__main__":
|
|
105
|
+
unittest.main()
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
"""Calculate company Git Flow versions from live remote refs; never write Git state."""
|
|
3
|
+
|
|
4
|
+
import argparse
|
|
5
|
+
import json
|
|
6
|
+
import re
|
|
7
|
+
import subprocess
|
|
8
|
+
import sys
|
|
9
|
+
from pathlib import Path
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
VERSION = re.compile(r"[0-9]+\.[0-9]+\.[0-9]+\Z")
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def git(repo, *args):
|
|
16
|
+
result = subprocess.run(
|
|
17
|
+
["git", "-C", str(repo), *args], capture_output=True, text=True, check=False
|
|
18
|
+
)
|
|
19
|
+
if result.returncode:
|
|
20
|
+
raise ValueError(result.stderr.strip() or f"git {' '.join(args)} failed")
|
|
21
|
+
return result.stdout.strip()
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
def version(text):
|
|
25
|
+
return tuple(map(int, text.split("."))) if VERSION.fullmatch(text) else None
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
def render(parts):
|
|
29
|
+
return ".".join(map(str, parts))
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
def calculate(args):
|
|
33
|
+
if args.production not in ("main", "master"):
|
|
34
|
+
raise ValueError("production must be main or master")
|
|
35
|
+
if not re.fullmatch(r"[A-Za-z0-9][A-Za-z0-9._/-]*", args.remote):
|
|
36
|
+
raise ValueError("invalid remote name")
|
|
37
|
+
finishing = args.mode.startswith("finish-")
|
|
38
|
+
if finishing and args.bump not in ("patch", "minor", "major"):
|
|
39
|
+
raise ValueError("finish requires --bump patch|minor|major after compatibility assessment")
|
|
40
|
+
|
|
41
|
+
repo = Path(args.repo).resolve()
|
|
42
|
+
if Path(git(repo, "rev-parse", "--show-toplevel")).resolve() != repo:
|
|
43
|
+
raise ValueError("repo must be the repository root")
|
|
44
|
+
|
|
45
|
+
refs = git(repo, "ls-remote", "--heads", "--tags", args.remote).splitlines()
|
|
46
|
+
live = {}
|
|
47
|
+
for line in refs:
|
|
48
|
+
sha, ref = line.split("\t", 1)
|
|
49
|
+
live[ref] = sha
|
|
50
|
+
|
|
51
|
+
production_ref = f"refs/heads/{args.production}"
|
|
52
|
+
production_sha = live.get(production_ref)
|
|
53
|
+
if not production_sha:
|
|
54
|
+
raise ValueError(f"remote {production_ref} is missing")
|
|
55
|
+
tracking_ref = f"refs/remotes/{args.remote}/{args.production}"
|
|
56
|
+
if git(repo, "rev-parse", "--verify", tracking_ref) != production_sha:
|
|
57
|
+
raise ValueError("local remote-tracking production branch is stale; fetch and retry")
|
|
58
|
+
|
|
59
|
+
merged_tags = set(git(repo, "tag", "--merged", tracking_ref).splitlines())
|
|
60
|
+
local_tags = dict(
|
|
61
|
+
line.split("\t", 1)
|
|
62
|
+
for line in git(repo, "for-each-ref", "--format=%(refname)%09%(objectname)", "refs/tags").splitlines()
|
|
63
|
+
)
|
|
64
|
+
reachable = []
|
|
65
|
+
for ref, sha in live.items():
|
|
66
|
+
if not ref.startswith("refs/tags/") or ref.endswith("^{}"):
|
|
67
|
+
continue
|
|
68
|
+
name = ref.removeprefix("refs/tags/")
|
|
69
|
+
parsed = version(name)
|
|
70
|
+
if parsed is None:
|
|
71
|
+
continue
|
|
72
|
+
if local_tags.get(ref) != sha:
|
|
73
|
+
raise ValueError(f"local tag {name} differs from remote; fetch and retry")
|
|
74
|
+
if name in merged_tags:
|
|
75
|
+
reachable.append((parsed, name))
|
|
76
|
+
if not reachable:
|
|
77
|
+
raise ValueError("no X.Y.Z tag reachable from remote production branch")
|
|
78
|
+
|
|
79
|
+
tag_number, tag_name = max(reachable)
|
|
80
|
+
result = {
|
|
81
|
+
"status": "ok",
|
|
82
|
+
"mode": args.mode,
|
|
83
|
+
"production": args.production,
|
|
84
|
+
"production_sha": production_sha,
|
|
85
|
+
"base_tag": tag_name,
|
|
86
|
+
}
|
|
87
|
+
if finishing:
|
|
88
|
+
major, minor, patch = tag_number
|
|
89
|
+
if args.bump == "patch":
|
|
90
|
+
minimum = (major, minor, patch + 1)
|
|
91
|
+
elif args.bump == "minor":
|
|
92
|
+
minimum = (major, minor + 1, 0)
|
|
93
|
+
else:
|
|
94
|
+
minimum = (major + 1, 0, 0)
|
|
95
|
+
result.update(bump=args.bump, minimum_version=render(minimum))
|
|
96
|
+
hotfixes = []
|
|
97
|
+
for ref in live:
|
|
98
|
+
if ref.startswith("refs/heads/hotfix/"):
|
|
99
|
+
name = ref.removeprefix("refs/heads/hotfix/")
|
|
100
|
+
parsed = version(name)
|
|
101
|
+
if parsed is not None:
|
|
102
|
+
hotfixes.append((parsed, name))
|
|
103
|
+
|
|
104
|
+
if args.mode == "create-hotfix":
|
|
105
|
+
highest_hotfix = max(hotfixes) if hotfixes else None
|
|
106
|
+
result["highest_remote_hotfix"] = highest_hotfix[1] if highest_hotfix else None
|
|
107
|
+
base = max(tag_number, highest_hotfix[0]) if highest_hotfix else tag_number
|
|
108
|
+
candidate = render((base[0], base[1], base[2] + 1))
|
|
109
|
+
result["candidate"] = f"hotfix/{candidate}"
|
|
110
|
+
if highest_hotfix and highest_hotfix[0] > tag_number and highest_hotfix[0][:2] != tag_number[:2]:
|
|
111
|
+
result["status"] = "needs_review"
|
|
112
|
+
result["reason"] = "highest hotfix uses a newer version line than the production tag"
|
|
113
|
+
if f"refs/heads/hotfix/{candidate}" in live:
|
|
114
|
+
raise ValueError("candidate hotfix branch already exists on remote")
|
|
115
|
+
elif args.mode in ("finish-feature", "finish-hotfix"):
|
|
116
|
+
result["candidate"] = render(minimum)
|
|
117
|
+
else:
|
|
118
|
+
if not args.branch or not args.branch.startswith("release/"):
|
|
119
|
+
raise ValueError("release mode requires --branch release/X.Y.Z")
|
|
120
|
+
target = args.branch.removeprefix("release/")
|
|
121
|
+
parsed = version(target)
|
|
122
|
+
if parsed is None or parsed <= tag_number:
|
|
123
|
+
raise ValueError("release version must be X.Y.Z and higher than production tag")
|
|
124
|
+
if finishing and parsed < minimum:
|
|
125
|
+
raise ValueError(f"release version must be at least {render(minimum)} for --bump {args.bump}")
|
|
126
|
+
result["candidate"] = target
|
|
127
|
+
|
|
128
|
+
if args.mode == "create-release":
|
|
129
|
+
if f"refs/heads/{args.branch}" in live:
|
|
130
|
+
raise ValueError("candidate release branch already exists on remote")
|
|
131
|
+
|
|
132
|
+
if args.mode.startswith("finish-") or args.mode == "create-release":
|
|
133
|
+
candidate = result["candidate"]
|
|
134
|
+
if f"refs/tags/{candidate}" in live:
|
|
135
|
+
raise ValueError(f"remote tag {candidate} already exists")
|
|
136
|
+
other = [
|
|
137
|
+
f"{kind}/{candidate}" for kind in ("hotfix", "release")
|
|
138
|
+
if f"refs/heads/{kind}/{candidate}" in live and f"{kind}/{candidate}" != args.branch
|
|
139
|
+
]
|
|
140
|
+
if other:
|
|
141
|
+
result["status"] = "needs_review"
|
|
142
|
+
result["reason"] = "candidate version has another remote branch: " + ", ".join(other)
|
|
143
|
+
return result
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
def main():
|
|
147
|
+
parser = argparse.ArgumentParser(description=__doc__)
|
|
148
|
+
parser.add_argument("mode", choices=("create-hotfix", "create-release", "finish-feature", "finish-hotfix", "finish-release"))
|
|
149
|
+
parser.add_argument("--repo", default=".")
|
|
150
|
+
parser.add_argument("--remote", required=True)
|
|
151
|
+
parser.add_argument("--production", required=True)
|
|
152
|
+
parser.add_argument("--branch", help="source branch; required for release modes")
|
|
153
|
+
parser.add_argument("--bump", choices=("patch", "minor", "major"), help="assessed numeric increment; required for finish modes")
|
|
154
|
+
args = parser.parse_args()
|
|
155
|
+
try:
|
|
156
|
+
print(json.dumps(calculate(args), ensure_ascii=False, separators=(",", ":")))
|
|
157
|
+
except (ValueError, OSError) as exc:
|
|
158
|
+
print(json.dumps({"status": "error", "reason": str(exc)}, ensure_ascii=False), file=sys.stderr)
|
|
159
|
+
return 2
|
|
160
|
+
return 0
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
if __name__ == "__main__":
|
|
164
|
+
sys.exit(main())
|