gitlink-cli/skills/gitlink-pm/REFERENCE.md

3.0 KiB
Raw Permalink Blame History

gitlink-pm 参考手册

本文档定义项目管理相关命令的字段映射和 API 说明。


一、里程碑 API 字段

milestone +list 返回字段

{
  "ok": true,
  "data": {
    "total_count": 4,
    "opening_milestone_count": 4,
    "closed_milestone_count": 0,
    "milestones": [
      {
        "id": 2761,
        "name": "v2.0",
        "description": "新里程碑",
        "effective_date": "2026-07-01",
        "status": "open",
        "issues_count": 0,
        "close_issues_count": 0,
        "opened_issues_count": 0,
        "percent": 0,
        "created_at": "2026-05-28 17:07",
        "updated_on": "2026-05-28 17:07"
      }
    ]
  }
}
字段 类型 说明
id int 里程碑 ID创建 Issue 时传给 --milestone
name string 里程碑名称
description string/null 里程碑描述
effective_date string/null 截止日期
status string "open" 或 "closed"
issues_count int 关联的 Issue 总数
close_issues_count int 已关闭 Issue 数
opened_issues_count int 开放 Issue 数
percent int 完成百分比

标签 API 字段

label +list 返回字段

{
  "ok": true,
  "data": {
    "total_count": 13,
    "issue_tags": [
      {
        "id": 323830,
        "name": "功能",
        "color": "#ee955a",
        "description": "表示新功能申请",
        "issues_count": 0,
        "created_at": "2026-05-21 16:54"
      }
    ]
  }
}
字段 类型 说明
id int 标签 ID
name string 标签名称
color string 标签颜色Hex
description string 标签说明
issues_count int 关联的 Issue 数

二、PM 模块 API 端点

以下端点需要项目开启 DevOps/PM 模块(open_devops: true)。

端点 方法 说明
/pm/dashboards GET 项目看板
/pm/sprint_issues GET Sprint Issue 列表
/pm/weekly_issues GET 周报 Issue
/pm/issue_tags GET PM Issue 标签
/pm/pipelines GET 流水线列表
/pm/action_runs GET Action 运行记录

所有 PM 端点都需要 project_id 参数:

gitlink-cli api GET /pm/dashboards --query 'project_id=1547045'

未开启 PM 模块的表现

如果项目未开启 PM 模块API 返回 HTML 页面而非 JSON这是正常的——说明该功能未激活。


三、轻量项目管理替代方案

未开启 PM 的项目,可用 milestone + label + issue 组合:

PM 功能 替代方案
Sprint milestone +create 创建 Sprint 命名的里程碑
看板 issue +list --state open + 标签过滤
标签分类 label +create + issue +update --label
进度跟踪 milestone +list 查看 percent 字段

四、获取 project_id

gitlink-cli repo +info --owner <owner> --repo <repo> --format json
# "project_id": 1547045