feat(jira): 增强提交检查和文档路径规范
- 添加已推送提交检查，避免不安全的 amend 操作
- 规范文档保存路径为 `doc/{日期}` 格式
- 扩展 markdown 解析支持表格和更多格式
- 优化 Jira 搜索 API 调用方式
This commit is contained in:
@@ -42,6 +42,10 @@ $head = git rev-parse HEAD
|
||||
$provided = git rev-parse <hash>
|
||||
if ($head -ne $provided) { Write-Error "提交不是 HEAD，无法 amend" }
|
||||
|
||||
# 检查提交是否已推送到远程
|
||||
git branch -r --contains <hash>
|
||||
# 如果有输出，说明已推送，Step 5 将跳过 amend
|
||||
|
||||
# 获取完整 diff 和元数据
|
||||
git show <hash>
|
||||
|
||||
@@ -63,6 +67,7 @@ git diff-tree --no-commit-id -r --name-status <hash>
|
||||
| `+` 行 | 新增代码（方法签名、接口、配置） |
|
||||
| `-` 行 | 删除/替换代码 |
|
||||
| 文件路径中的包名 | 推断所属服务（`g3fo-trade-service`, `g3fo-margin-service` 等） |
|
||||
| `git branch -r --contains` 输出 | 是否已推送（有输出 = 已推送，跳过 amend） |
|
||||
|
||||
G3FO 服务包路径规律：
|
||||
- `com.afe.g3fo.<service-short-name>.*` → 对应服务
|
||||
@@ -171,6 +176,17 @@ G3FO 服务包路径规律：
|
||||
|
||||
## Step 3: Jira 任务查找与确认
|
||||
|
||||
### 用户已提供 Jira 编号
|
||||
|
||||
如果用户已提供 Jira 编号（如 `G3SF-123`）：
|
||||
- **直接使用该编号**，跳过 JQL 搜索、列表展示和新建流程
|
||||
- **禁止**执行搜索、展示列表或创建新 Issue
|
||||
- 直接进入 Step 4 上传文档和评论
|
||||
|
||||
### 用户未提供 Jira 编号
|
||||
|
||||
执行 JQL 查询：
|
||||
|
||||
### JQL 查询
|
||||
|
||||
```
|
||||
@@ -231,12 +247,23 @@ Summary 生成规则：
|
||||
- `<JIRA-ID>_Dev_Plan.md`
|
||||
- `<JIRA-ID>_Impact_Analysis.md`
|
||||
- `<JIRA-ID>_Task_Summary.md`
|
||||
仅保存本任务类型要求的那几份（见 [2.1 按任务类型确定需生成的文档](#21-按任务类型确定需生成的文档)）。保存位置：当前 Git 项目根目录或项目约定目录（如 `docs/`）。
|
||||
仅保存本任务类型要求的那几份（见 [2.1 按任务类型确定需生成的文档](#21-按任务类型确定需生成的文档)）。
|
||||
|
||||
**保存路径规则**：
|
||||
- 所有文档统一保存到项目根目录下的 `doc/{日期}` 文件夹
|
||||
- 日期格式为 `YYYY-MM-DD`（如 `doc/2026-03-26`）
|
||||
- 若该文件夹不存在，**必须先创建**再保存文件
|
||||
- 完整路径示例：`doc/2026-03-26/G3SF-123_Impact_Analysis.md`
|
||||
|
||||
2. **上传到 Jira 附件**：Atlassian MCP 不支持上传文件，使用本技能自带脚本上传上述 MD 到当前 Issue：
|
||||
- 配置文件：在技能目录下配置 `jira_upload.env`（`JIRA_BASE_URL`、`JIRA_EMAIL`、`JIRA_API_TOKEN`），详见 `references/env_config.md`。
|
||||
- 命令示例（PowerShell 用 `;` 连接，勿用 `&&`），按需上传多文件：
|
||||
```powershell
|
||||
python skills/g3fo-commit-jira/scripts/upload_attachment.py --config "skills/g3fo-commit-jira/jira_upload.env" --issue "G3SF-101" --file "G3SF-101_Impact_Analysis.md" --file "G3SF-101_Dev_Plan.md" --file "G3SF-101_Task_Summary.md"
|
||||
# 创建日期目录（若不存在）
|
||||
$dateFolder = "doc/$(Get-Date -Format 'yyyy-MM-dd')"
|
||||
if (-not (Test-Path $dateFolder)) { New-Item -ItemType Directory -Path $dateFolder -Force }
|
||||
|
||||
python skills/g3fo-commit-jira/scripts/upload_attachment.py --config "skills/g3fo-commit-jira/jira_upload.env" --issue "G3SF-101" --file "$dateFolder/G3SF-101_Impact_Analysis.md" --file "$dateFolder/G3SF-101_Dev_Plan.md" --file "$dateFolder/G3SF-101_Task_Summary.md"
|
||||
```
|
||||
- 未配置 `jira_upload.env` 时跳过上传，仅写评论。
|
||||
|
||||
@@ -259,6 +286,28 @@ Summary 生成规则：
|
||||
|
||||
## Step 5: Git Amend 命令详解
|
||||
|
||||
### 检查提交是否已推送
|
||||
|
||||
在执行 amend 前，必须检查提交是否已推送到远程：
|
||||
|
||||
```powershell
|
||||
# 检查提交是否已推送
|
||||
$pushedBranches = git branch -r --contains <hash>
|
||||
if ($pushedBranches) {
|
||||
Write-Host "提交已推送到远程，跳过 amend"
|
||||
Write-Host "已完成 Jira 绑定和文档上传"
|
||||
Write-Host "如需修改 commit message，请手动处理或提供特别说明"
|
||||
# 跳过 amend，直接结束
|
||||
return
|
||||
}
|
||||
```
|
||||
|
||||
**已推送的处理**：
|
||||
- 如果 `git branch -r --contains <hash>` 有输出，说明提交已推送到远程分支
|
||||
- **跳过 amend**，仅完成 Jira 绑定和文档上传
|
||||
- 告知用户提交已推送，无法 amend
|
||||
- 例外：用户明确要求修改已推送的提交时，需确认风险后再执行
|
||||
|
||||
### PowerShell（Windows 环境）
|
||||
|
||||
在 Windows PowerShell 中，直接使用 `$origMsg` 可能会导致编码问题（乱码）。必须显式指定输出编码为 UTF8。
|
||||
@@ -331,6 +380,7 @@ git log --oneline -1 # 查看 commit 摘要
|
||||
|---------|---------|---------|
|
||||
| 修订号不存在 | `git rev-parse <hash>` 报错 | **停止**，提示用户提供正确的修订号。 |
|
||||
| 提交 hash 不是 HEAD | `git rev-parse HEAD` ≠ `git rev-parse <hash>` | 停止，提示用户确认 hash（只有 HEAD 才能 amend）。 |
|
||||
| 提交已推送到远程 | `git branch -r --contains <hash>` 有输出 | **跳过 amend**，仅完成 Jira 绑定和文档上传，告知用户提交已推送。 |
|
||||
| 项目路径不正确 | `git rev-parse --is-inside-work-tree` 失败 | 提示用户在正确的 git 项目目录下操作。 |
|
||||
| 无 MCP 且未配置 jira_upload.env | 无法执行 jira_cli / 上传 | **必须**配置 `jira_upload.env` 或改用 Cursor + MCP。 |
|
||||
| Atlassian MCP 未鉴权 | `STATUS.md` 有提示 / 工具调用返回 401 | 调用 `mcp_auth`，或改用 `jira_cli.py`。 |
|
||||
@@ -338,6 +388,7 @@ git log --oneline -1 # 查看 commit 摘要
|
||||
| Jira 项目 G3SF 不存在 | 创建/搜索返回 404/400 | 提示用户确认 `JIRA_BASE_URL`、项目 key；`create` 可用 `--project` |
|
||||
| 工作区有未提交变更 | `git status --porcelain` 有输出 | 警告：amend 会将未暂存变更排除在外，建议先 `git add` 或 stash |
|
||||
| commit message 中已有 Jira 行 | message 中包含 `**** Jira` | 跳过追加，提示用户该提交已绑定 |
|
||||
| 用户已提供 Jira 编号 | 用户输入包含 Jira key | **跳过搜索和新建**，直接使用用户提供的编号 |
|
||||
| Jira 搜索无结果 | 工具返回空列表 | 直接进入新建流程，无需用户确认 |
|
||||
| 未配置 jira_upload.env | 上传前检查配置不存在 | **有 MCP**：跳过上传，仅评论。**无 MCP**：无法完成 Jira 操作，须配置 env 或使用 MCP。 |
|
||||
| 任务类型判定为「无需文档」 | 按政策表属简单漏洞/琐碎改动 | 不生成报告、不写评论、不上传附件；仍执行 Jira 绑定与 commit --amend，将 Jira 编号追加到 commit message |
|
||||
|
||||
Reference in New Issue
Block a user