Jira Issue

Jira Issue

Overview

使用当前 skill 目录内脚本访问 Jira REST API v2。命令只依赖 skill 内部结构：pyproject.toml 与 scripts/。

uv run --project . python3 scripts/<script>.py ...

以下命令都假设当前目录就是 jira-issue 这个 skill 目录。默认配置来源按以下优先级生效：

• 命令行参数
• 当前 shell 环境变量
• 当前 workspace 下的 .env

JIRA_URL 必须通过命令行、环境变量或 .env 显式配置。

--dry-run 只打印 payload，不会发请求，也不要求 JIRA_URL / JIRA_TOKEN。

Quick Start

1. 确认系统里已经有 uv；如果没有，让用户自行按官方文档安装。
2. 如需默认凭据，可写入当前 workspace 下的 .env；否则直接传 CLI 参数或使用当前 shell 环境变量。
3. Issue 描述和评论内容统一走 --description-file / --comment-file；传 stdin 时使用 -。
4. 先执行 --dry-run 预览 payload。
5. 确认无误后去掉 --dry-run 正式提交，并记录返回的 key / self 或 comment_id / self。

Prerequisites

• 需要 uv
• 如果 uv 不在 PATH，提示用户自行安装；本 skill 不提供安装流程

Create Issue

uv run --project . python3 scripts/jira_create_issue.py \
  --project-key <PROJECT_KEY> \
  --summary "..." \
  --description-file /path/to/description.md \
  --dry-run

常用参数：

• --auth：bearer 或 basic（默认 bearer）
• --project-key：也可用 JIRA_PROJECT
• --issue-type：也可用 JIRA_ISSUE_TYPE，默认 Bug
• --description-file：从文件读取描述；传 - 时从 stdin 读取
• --label/--component/--assignee/--priority
• --affects-version/--fix-version：对应 Affects Version / Fix Version（可重复）
• --epic：Epic issue key，创建成功后会将 issue 挂载到该 epic
• --print-payload/--dry-run

输出：key 与 self（若返回）。

经验示例：

uv run --project . python3 scripts/jira_create_issue.py \
  --project-key OPS \
  --issue-type Bug \
  --summary "Regression job failed with an out-of-memory error" \
  --description-file /path/to/description.md \
  --priority Highest \
  --assignee alice \
  --label storage \
  --label ingestion \
  --affects-version 1.2.3 \
  --fix-version 1.2.4

挂载到 Epic 的示例：

uv run --project . python3 scripts/jira_create_issue.py \
  --project-key OPS \
  --issue-type Bug \
  --summary "Planner produces an incorrect execution plan" \
  --description-file /path/to/description.md \
  --label planner \
  --epic OPS-1000 \
  --dry-run

创建成功后会输出 epic_linked=OPS-1000 表示已挂载到 epic。

stdin 示例：

uv run --project . python3 scripts/jira_create_issue.py \
  --project-key QA \
  --issue-type 任务 \
  --summary "..." \
  --description-file - <<'EOF'
第一行

第二行
EOF

Comment Issue

uv run --project . python3 scripts/jira_comment_issue.py \
  --issue-key OPS-12345 \
  --comment-file /path/to/comment.md \
  --dry-run

常用参数：

• --issue-key：目标 Issue key
• --comment-file：评论内容文件；传 - 时从 stdin 读取
• --print-payload / --dry-run：预览请求

输出：comment_id 与 self（若返回）。

Search Issues

使用 JQL 检索 Jira Issue（POST /rest/api/2/search）。搜索是只读操作，无需 --dry-run，直接执行即可。推荐使用 --jql 原始 JQL 方式，灵活度最高。

uv run --project . python3 scripts/jira_search_issue.py \
  --jql 'project = OPS AND labels = "planner"' \
  --max-results 10

JQL 语法速查（已验证）

JQL 格式：field operator value [AND/OR field operator value ...] [ORDER BY field ASC/DESC]

字符串匹配（~ 为包含，!~ 为不包含）：

精确匹配字段（= 为等于，!= 为不等于，IN / NOT IN 为多值）：

日期筛选：

其他操作符：IS / IS NOT（空值判断）、WAS / WAS NOT（历史状态）、CHANGED（字段变更）。

注意：status 和 issuetype 的 JQL 值必须用英文名称或数字 ID 而非中文翻译名（如 Bug 而非 故障，"In Review" 而非 处理中）。可用 GET /rest/api/2/status 和 GET /rest/api/2/issuetype 查看有效值。

搜索方式

原始 JQL 搜索（推荐）

传入 --jql 直接使用 JQL，最灵活：

# 按 label + 关键词 + 近期创建
uv run --project . python3 scripts/jira_search_issue.py \
  --jql 'project = OPS AND labels = "planner" AND summary ~ "Planner" AND created >= -7d' \
  --max-results 10

# 按多个 label + 优先级 + 时间排序
uv run --project . python3 scripts/jira_search_issue.py \
  --jql 'project = OPS AND labels IN ("ingestion", "storage") AND priority = High ORDER BY created DESC' \
  --max-results 20

# 按经办人 + 状态
uv run --project . python3 scripts/jira_search_issue.py \
  --jql 'project = OPS AND assignee = alice AND status = "In Review"'

参数组合搜索

通过多个筛选参数自动拼接 JQL，适合简单查询：

# 按多个 label + assignee 搜索
uv run --project . python3 scripts/jira_search_issue.py \
  --project-key OPS \
  --label storage \
  --label ingestion \
  --assignee alice \
  --max-results 10

# 全文关键词搜索
uv run --project . python3 scripts/jira_search_issue.py \
  --project-key OPS \
  --keyword "内存" \
  --keyword-field text \
  --max-results 5

参数组合搜索只是 JQL 生成的快捷方式，复杂查询建议直接用 --jql。

常用参数

输出格式

紧凑格式（默认）：每行一个 issue 基本字段，评论数和附件数单独一行，用 --show-comments / --show-attachments / --show-description 查看详细内容：

total=8
key=OPS-1234 | summary=...NPE and break retry semantics | status=In Review | issuetype=Bug | ...
  comments=2
  attachments=1

带评论和附件详情（--show-comments --show-attachments）：

key=OPS-1234 | summary=... | status=In Review | ...
  [comment] Alice @ 2026-04-24T15:54:11.105+0800
    !screenshot-1.png|thumbnail!
  [comment] Bob @ 2026-04-24T16:46:36.154+0800
    https://github.com/octo-org/example-repo/pull/100
  attachments=1
    screenshot-1.png (779614 bytes, image/png) -> https://jira.example.com/secure/attachment/100/screenshot-1.png

JSON 格式（--output-json）：输出完整 API 响应 JSON。结果可能很大时使用 --output-file xxx，再用 jq / rg / 小脚本按需提取片段，不要把完整文件直接 cat 回终端。

典型调查流程

从 bug 现象（报错信息、堆栈、函数名）出发定位相关 Issue：

# Step 1: 用堆栈中的函数名全文搜索
uv run --project . python3 scripts/jira_search_issue.py \
  --jql 'project = OPS AND text ~ "planner exception"' \
  --show-comments --show-description --max-results 10

# Step 2: 对找到的 issue 查看完整评论和附件
uv run --project . python3 scripts/jira_search_issue.py \
  --jql 'project = OPS AND issuekey = OPS-1234' \
  --show-comments --show-attachments --show-description

# Step 3: 从评论中提取 PR/分支信息，通过 gh 等操作查看 PR 标签，追溯到修复版本

评论中常包含关键信息：修复 PR 链接、cherry-pick 分支、复现条件、根本原因分析。附件（screenshot、日志）可通过 content 字段的 URL 查看。

Config

发送请求时需要：

• JIRA_TOKEN

可选默认值：

• JIRA_URL：Jira base URL，例如 https://jira.example.com
• JIRA_USER：仅 --auth basic 时需要
• JIRA_PROJECT
• JIRA_ISSUE_TYPE

Common Mistakes

• --assignee 使用 Jira 用户名，不是邮箱，例如 alice
• 多行内容不要试图走内联参数；统一用 --description-file / --comment-file
• 需要动态内容时，用 --description-file - 或 --comment-file - 配合 heredoc
• 这些命令默认在 skill 目录内执行；如果不在该目录，先切到 skill 目录再运行
• 搜索时 status 和 issuetype 在 JQL 中必须用英文名或 ID（如 Bug 而非 故障，"In Review" 而非 处理中）。中文名只在 UI 显示层生效，JQL 查询无效。