README file from
GithubBranch Delivery Manager
在 Obsidian 桌面版中汇总 Git 分支、提交、关联事项、验收证据和上线检查。插件内置分支交付核心,无需安装 Codex Skill 或额外的本机脚本即可登记和扫描 Git 仓库。
使用
- 安装并启用插件。电脑需要安装 Git,且目标仓库已经在本机克隆。
- 从命令面板运行“分支交付中心:登记 Git 仓库”,填写本地仓库路径。
- 运行“打开分支交付中心”,通过“扫描分支”读取远端分支和提交。
插件把交付记录保存在当前仓库的 04.项目/00.分支管理 目录。扫描会对已登记仓库执行 git fetch origin,因此可能访问相应 Git 远端;插件不会自动提交、推送或修改远端分支。
插件会读取用户登记的本地 Git 仓库(可能位于 Obsidian vault 之外),并在存在本机 Codex 同步档案时读取 ~/.codex/obsidian-sync/state 中的关联信息。仓库扫描通过 git fetch origin 使用网络;启用可选的 Codex CLI 智能关联时,提交信息会按该 CLI 的配置发送到其服务。
可选集成
- Codex CLI:安装并在设置中指定其可执行文件后,可为提交提供智能关联建议。使用该功能会由 Codex CLI 处理提交信息;明确编号的关联不要求 Codex CLI。
- 禅道:可填写禅道网页地址,以便打开关联任务和 Bug。读取 Bug 最新状态还需要在设置中指定兼容的禅道只读客户端脚本,并由用户自行配置该客户端的访问凭据。插件不附带凭据。
- Codex 会话档案:已有本机 Codex Obsidian 同步档案时,可显示提交关联的会话;没有该档案时,其他分支交付功能仍可使用。
设置保存在 Obsidian 插件数据中,不包含在 GitHub Release。旧安装的交付记录和设置会保留;升级时不要删除原插件目录中的 data.json。
手动安装与构建
下载同一版本 Release 中的 main.js、manifest.json 和 styles.css,放入 vault 的 .obsidian/plugins/branch-delivery-manager/,然后启用插件。源码构建运行 npm run build,产物为仓库根目录的上述三个文件。
许可证
MIT,见 LICENSE。