看板导出
看板导出功能将当前项目状态生成静态 Markdown 文件,便于在 README 中嵌入、发送邮件汇报或存档到版本控制中。
导出为 Markdown 表格
# 导出到默认文件 Backlog.md
backlog board export
# 导出到指定文件
backlog board export project-status.md
# 强制覆盖已存在的文件
backlog board export --force
导出文件包含以下内容:
- 项目标题与导出时间戳
- 版本标注(若指定了
--export-version) - 按状态分列的 Markdown 表格,每行显示任务 ID、标题、负责人和标签
- 元数据汇总:各状态任务数量、完成百分比
子任务以
└─前缀列在父任务之后;更深层级的后代任务(如子任务的子任务)同样按 ID 顺序递归列出,不会遗漏。注意:默认导出目标为项目根目录的
Backlog.md。若该文件已存在且未加--force,命令会提示确认是否覆盖。
嵌入 README.md
如果希望将看板状态直接展示在仓库首页,可使用 --readme 标志:
backlog board export --readme
该命令会在 README.md 中查找看板标记占位符:
<!-- BACKLOG BOARD START -->
<!-- BACKLOG BOARD END -->
找到后,将当前看板表格插入到两个标记之间。如果 README 中不存在这对标记,命令会提示你手动添加。
此功能常用于开源项目,让访问者第一眼就能看到当前迭代进度。
导出版本标注
在发布节点或里程碑完成时,可为导出内容附加版本信息:
# 简单版本号
backlog board export --export-version "v1.2.3"
# 组合使用:嵌入 README 并标注版本
backlog board export --readme --export-version "Release 2024.12.1-beta"
版本字符串会显示在导出表格的标题下方,方便与历史导出记录区分。
自动化导出示例
在 CI/CD 或发布脚本中集成看板导出:
# 发布前自动更新 README 看板
backlog board export --readme --force --export-version "$GITHUB_REF_NAME"
git add README.md Backlog.md
git commit -m "chore: update board snapshot"
提示:由于
backlog board export是纯读取操作,即使在没有写权限的 CI 环境中也能安全执行。若需提交结果,请确保流水线配置了相应的 Git 凭据。