同步 GitCode CLI 案例到发布平台文档
场景
GitCode CLI 团队维护了一套应用案例,希望把其中与发布平台相关的案例同步到 openLiBingNext/openlibing-platform-release 的文档目录,供发布平台团队在自己的仓库内查看和复用。这个场景适合用 gitcode repo sync 自动创建目标仓库 PR。
推荐 skill
gitcode-repo— 来自 gitcode-cli/skills 项目(git@gitcode.com:gitcode-cli/skills.git),可独立安装使用
适用人群
- 平台团队、文档团队
- 多仓维护者
- DevOps(跨仓同步 CI 配置、规范模板)
可直接执行的 Prompt
请使用 gitcode-repo skill,帮我把当前 gitcode-cli 仓库的 Example/cases 同步到 openLiBingNext/openlibing-platform-release 的 docs/gitcode-cli-cases,并创建 Pull Request。
请全程使用 `gitcode` 命令入口;repo sync 涉及代码传输,默认使用 SSH。
输入:
- source_dir: Example/cases
- target_repo: openLiBingNext/openlibing-platform-release
- target_dir: docs/gitcode-cli-cases
- base_branch: master
- 同步目的:把 GitCode CLI 在发布平台场景中的案例沉淀到发布平台仓库,方便团队成员直接复制 prompt 使用。
请先说明将执行的同步计划、PR 标题和正文,等我确认后再执行。
预期产出
openLiBingNext/openlibing-platform-release中新增或更新docs/gitcode-cli-cases/。- 自动创建一个同步 PR,说明来源、目标目录和复用价值。
价值
- 让 GitCode CLI 案例不只停留在 CLI 仓库,也能进入业务仓库的日常文档入口。
- 平台团队无需手动复制多份 Markdown,降低文档漂移。
repo sync自动完成 clone、copy、commit、push、create PR,展示 CLI 在多仓协作中的效率价值。
复用方式
替换清单
| 占位符 | 案例值 | 替换为 |
|---|---|---|
| 源目录 | Example/cases |
源仓库中的目录路径 |
| 目标仓库 | openLiBingNext/openlibing-platform-release |
目标仓库 |
| 目标目录 | docs/gitcode-cli-cases |
目标仓库中的目录路径 |
| 目标分支 | master |
目标仓库默认分支 |
| 同步目的 | 案例沉淀 | 同步的业务原因 |
适用场景
- 跨仓库同步文档、规范、模板、CI 配置
- 多仓组织的知识分发
- 不适合:二进制大文件同步(应使用 release 资产或制品仓库)
跨平台提醒
gitcode repo sync内部使用 SSH,需确认ssh -T git@gitcode.com可用- 目标目录会被完整覆盖(非增量合并),注意不要覆盖目标仓库的手动修改
前置条件
- 对源仓库和目标仓库都有读写权限
- 源目录内容已准备好
- SSH 已配置
本次真实执行记录
本案例已从 gitcode-cli/cli 当前分支把 Example/cases 同步到目标仓:
- 目标仓:
openLiBingNext/openlibing-platform-release - 目标目录:
docs/gitcode-cli-cases - 同步分支:
sync/gitcode-cli-cli/codex-add-example-case-library/example-cases - 远端 PR:#5 docs: sync GitCode CLI example cases
- 变更规模:9 个 Markdown 文件,新增 449 行,删除 0 行
- 合并状态:
mergeable=true
这个案例的价值不只是”复制文件”,而是形成跨仓库文档分发闭环:源仓继续维护案例库,目标业务仓通过 PR 审查后获得团队内可直接阅读的使用手册。对多仓库组织来说,这种方式可以复用到 API 契约、规范模板、CI 片段、SDK 示例同步。
相关案例
- 关联:新成员上手发布平台仓库 — 同步后的文档供新成员阅读
- 关联:发布 openLiBing 发布平台版本 — 文档同步可作为 release 的一部分