GitHub扩展开发：如何实现同仓库成员间的数据同步？

嘿，我之前做过类似的GitHub扩展功能，刚好能给你分享下核心实现思路——本质就是别把同步数据存在用户本地，而是托管在和仓库绑定的远程存储里，这样所有成员访问时都拉取同一个数据源。具体可以拆成这几个关键步骤来做：

1. 选对仓库关联的远程存储载体 #

因为要和仓库强绑定，且所有有权限的成员都能访问，优先用GitHub原生提供的能力，不用自己搭后端：

• 仓库隐藏配置文件：通过GitHub API的Contents接口，在仓库根目录创建一个隐藏文件夹（比如.your-extension/），里面放config.json来存储Pipeline这类同步数据。所有有仓库读写权限的成员都能通过API读写这个文件，天然实现多人间的同步。
• 复用GitHub Projects：如果你的Pipeline和任务卡片强关联，直接复用GitHub原生的Projects功能，通过API操作项目的列（Columns）。这样成员不仅在你的扩展里能看到同步后的Pipeline，在GitHub原生界面也能看到，减少适配成本。
• GitHub App私有存储：如果你的扩展是GitHub App形式，可以用GitHub提供的安装级存储，但这个更适合不需要用户直接编辑配置的场景，灵活性不如前两种。

2. 本地与远程的同步逻辑 #

• 初始化拉取：用户打开仓库时，扩展第一件事就是调用GitHub API拉取远程存储的最新配置，覆盖本地缓存，确保所有人看到的是同一版本的Pipeline数据。
• 实时监听变更：
  • 用GitHub Webhooks监听仓库的content变更事件（如果用配置文件），或者project_column变更事件（如果用Projects）。一旦有成员修改了配置，你的后端服务（或者浏览器的Service Worker）接收Webhook后，通知所有打开该仓库的用户刷新数据。
  • 如果不想搭后端，也可以做定期轮询（比如每30秒拉取一次远程配置），虽然效率稍低，但实现简单，适合初期版本。
• 本地操作的提交：当用户删除Backlog这类Pipeline时，先通过GitHub API验证用户的仓库写入权限，然后修改远程存储的配置（比如更新JSON文件里的Pipeline列表，或者删除Projects里的对应列），成功后再更新本地UI，确保后续所有成员拉取到的都是修改后的版本。

3. 权限控制不能少 #

• 完全依赖GitHub的原生权限体系：调用GET /repos/{owner}/{repo}/collaborators/{username}/permission接口检查用户权限，只有拥有写入权限的成员才能修改同步数据，只读权限的用户只能看不能改，避免乱操作。

4. 冲突处理要考虑 #

• 多个成员同时修改时，用GitHub API的乐观锁机制：提交修改时带上当前配置文件的SHA值（拉取配置时能拿到），如果SHA不匹配，说明有其他成员先修改了，提示用户刷新页面后再操作。
• 也可以在扩展里做简单的冲突合并提示，让用户选择覆盖还是合并他人的变更，不过乐观锁是最基础且高效的方式。

示例代码片段（用GitHub Contents API删除Pipeline） #

假设你已经通过GitHub OAuth拿到了用户的访问令牌，下面是删除Pipeline并同步到远程的核心代码：

async function deletePipeline(repoOwner, repoName, pipelineId, userToken) {
  // 1. 拉取当前远程配置文件
  const configApiUrl = `https://api.github.com/repos/${repoOwner}/${repoName}/contents/.your-extension/config.json`;
  const currentConfigResp = await fetch(configApiUrl, {
    headers: { Authorization: `token ${userToken}` }
  });
  const currentConfigData = await currentConfigResp.json();
  
  // 解码base64格式的文件内容
  const currentContent = atob(currentConfigData.content);
  const pipelineConfig = JSON.parse(currentContent);

  // 2. 删除目标Pipeline
  pipelineConfig.pipelines = pipelineConfig.pipelines.filter(p => p.id !== pipelineId);

  // 3. 提交修改到远程（带上SHA做乐观锁）
  const updatedContent = btoa(JSON.stringify(pipelineConfig));
  await fetch(configApiUrl, {
    method: 'PUT',
    headers: { Authorization: `token ${userToken}` },
    body: JSON.stringify({
      message: `Delete pipeline: ${pipelineId}`,
      content: updatedContent,
      sha: currentConfigData.sha
    })
  });
}

内容的提问来源于stack exchange，提问作者yakkisyou