feat(workflows): 新增 doc-sync-automation 中英文档一致性守护端到端工作流 #332

Taoyouce · 2026-07-05T17:49:03+08:00

Taoyouce commented

2026-07-05 17:49:03 +08:00

背景

本仓库自身即维护 README.md + README.zh-CN.md 双语文档，且实测两版已存在漂移（代码块 32 vs 29、表格 43 vs 40 行）。把 gitlink-doc-sync Skill（PR #331）包成可直接运行、可进 CI 的端到端工作流。

闭环

采集 → 检测 → 报告 → 回写：

repo +tree 按命名约定自动发现双语文档对（README/CONTRIBUTING/CHANGELOG 及其 zh-CN 变体）
file +view --raw 拉取两版全文，做确定性结构比对：章节大纲 / 代码块数与行数 / 表格行数 / 版本号
输出分级（?严重/?中等/?轻微）Markdown 漂移报告；退出码 2=存在严重漂移，可直接作 CI 门禁
--apply 时用 issue +create 把报告作为 tracking issue 真实回写（默认 dry-run）

与已有能力三层协同不重复：file 命令组（读写能力，PR #330）→ gitlink-doc-sync Skill（语义翻译同步，PR #331）→ 本工作流（确定性可复现闭环）。

交付物

scripts/doc_sync_workflow.py（纯标准库，零第三方依赖）
tests/test_drift.py 确定性回归护栏（9/9 全绿）
docs/verification.md 真实平台验证证据 + examples/demo-outputs/ 真实运行产物

已在生产 gitlink.org.cn 真实验证

验证	结果
文档对自动发现	✅ 自动识别 README.md ⇄ README.zh-CN.md
漂移检测	✅ 检出本仓库 README 双语版本的真实漂移
--apply 回写	✅ tracking issue 创建成功（API 回执确认）
单测	✅ 9/9

## 背景本仓库自身即维护 README.md + README.zh-CN.md 双语文档，且实测两版已存在漂移（代码块 32 vs 29、表格 43 vs 40 行）。把 gitlink-doc-sync Skill（PR #331）包成可直接运行、可进 CI 的端到端工作流。 ## 闭环 **采集 → 检测 → 报告 → 回写**： 1. `repo +tree` 按命名约定自动发现双语文档对（README/CONTRIBUTING/CHANGELOG 及其 zh-CN 变体） 2. `file +view --raw` 拉取两版全文，做确定性结构比对：章节大纲 / 代码块数与行数 / 表格行数 / 版本号 3. 输出分级（?严重/?中等/?轻微）Markdown 漂移报告；退出码 2=存在严重漂移，可直接作 CI 门禁 4. `--apply` 时用 `issue +create` 把报告作为 tracking issue 真实回写（默认 dry-run）与已有能力三层协同不重复：`file` 命令组（读写能力，PR #330）→ `gitlink-doc-sync` Skill（语义翻译同步，PR #331）→ 本工作流（确定性可复现闭环）。 ## 交付物 - `scripts/doc_sync_workflow.py`（纯标准库，零第三方依赖） - `tests/test_drift.py` 确定性回归护栏（9/9 全绿） - `docs/verification.md` 真实平台验证证据 + `examples/demo-outputs/` 真实运行产物 ## 已在生产 gitlink.org.cn 真实验证 | 验证 | 结果 | |------|------| | 文档对自动发现 | ✅ 自动识别 README.md ⇄ README.zh-CN.md | | 漂移检测 | ✅ 检出本仓库 README 双语版本的真实漂移 | | --apply 回写 | ✅ tracking issue 创建成功（API 回执确认） | | 单测 | ✅ 9/9 |

Taoyouce added 1 commit 2026-07-05 17:49:04 +08:00

d48e083959 feat(workflows): 新增 doc-sync-automation 中英文档一致性守护工作流

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>

Taoyouce added 1 commit 2026-07-05 18:42:42 +08:00

45ed4374bc chore: 移除误提交的 __pycache__；docs: 工作流补充架构图与 CI 门禁集成示例

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>

Taoyouce added 1 commit 2026-07-05 18:46:52 +08:00

8a3c56846b feat(doc-sync): 文档对发现泛化为通用命名约定并扫描 docs/ 目录，补充嵌套/翻译文件单测

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>

wbtiger merged commit 36ef51402b into master

2026-07-14 22:26:04 +08:00

wbtiger referenced this issue from a commit

2026-07-14 22:26:06 +08:00

Merge pull request 'feat(workflows): 新增 doc-sync-automation 中英文档一致性守护端到端工作流' (#332) from Taoyouce/gitlink-cli:feat/doc-sync-workflow into master

Sign in to join this conversation.

No reviewers

No Label

No Milestone

No project

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Gitlink/gitlink-cli#332