OSS Chat 如何自动同步 GitHub 议题到微信群？开源工具整合使用指南

? 核心功能与优势

? 准备工作

1. 注册 GitHub 账号：如果你还没有 GitHub 账号，需要先在官网完成注册，并创建一个用于测试的仓库。
2. 安装 Node.js：OSS Chat 依赖 Node.js 环境，建议安装最新的 LTS 版本。
3. 申请微信机器人权限：目前 OSS Chat 支持通过企业微信机器人或普通微信群机器人接收消息。如果是企业微信，需要在管理后台创建应用并获取 Webhook 地址；如果是普通微信群，可通过第三方平台（如微友助手）生成机器人。

? 配置 GitHub 端

1. 安装 OSS Chat 应用：登录 GitHub，进入仓库的 Settings - Apps，搜索 “OSS Chat” 并安装。授权时选择 “Read metadata” 和 “Read/Write issues & PRs” 权限。
2. 设置 Webhook：在仓库的 Settings - Webhooks 中点击 “Add webhook”，Payload URL 填写 OSS Chat 的回调地址（格式为 https://your-oss-chat-domain/webhook），Content type 选择 application/json，并设置一个复杂的 Secret 密钥。
3. 订阅事件：勾选 “Issues” 和 “Issue comments” 事件，确保当议题创建或评论时触发 Webhook。

? 配置微信端

1. 添加 OSS Chat 机器人：无论是企业微信还是普通微信群，都需要将 OSS Chat 机器人添加到目标群中。企业微信机器人可通过管理后台生成二维码，普通群机器人则需通过第三方平台获取邀请链接。
2. 获取群组 ID：在 OSS Chat 的控制台（https://oss.chat/dashboard）中，找到已添加的群，复制其群组 ID。
3. 编辑配置文件：在 OSS Chat 的项目目录中，找到 config.ts 文件，添加以下内容：

export const managedRepoConfig: RepoConfig = {
  repoOwner: 'your-github-username',
  repoName: 'your-repo-name',
  groupId: 'your-wechat-group-id',
  webhookSecret: 'your-webhook-secret'
};

? 验证与测试

1. 启动 OSS Chat：在项目目录中执行 npm run start，等待机器人登录微信并加入群组。
2. 创建测试议题：在 GitHub 仓库中新建一个议题，填写标题和描述。
3. 查看微信消息：几秒钟后，微信群中应该会收到一条包含议题链接、标题、描述和创建者信息的消息。点击链接可直接跳转到 GitHub 页面。
4. 测试评论同步：在议题下添加一条评论，观察微信是否收到更新通知。

?️ 高级设置

1. 自定义消息模板：在 config.ts 中修改 messageTemplate 字段，可定制消息的格式和内容。例如，添加标签或优先级信息：

messageTemplate: (issue) => `新议题：[${issue.labels.join(', ')}] ${issue.title}\n${issue.body}\n${issue.html_url}`

2. 设置过滤规则：通过 filter 字段可以指定只同步特定标签或状态的议题：

filter: (issue) => issue.labels.includes('bug') && issue.state === 'open'

3. 多仓库管理：在 managedRepoConfig 数组中添加多个仓库配置，可同时监控多个项目。

? 常见问题与解决

1. 消息不同步：
   • 检查 GitHub Webhook 的 Recent Deliveries 日志，查看是否有失败记录。
   • 确认 OSS Chat 机器人已加入微信群并拥有发送消息的权限。
   • 检查 config.ts 中的群组 ID 和 Webhook Secret 是否正确。
   
   
2. 格式错乱：
   • 确保消息模板中的 Markdown 语法正确，例如使用 [] 包裹链接。
   • 如果是企业微信，需注意 Webhook 消息的格式要求，部分富文本功能可能不支持。
   
   
3. 性能问题：
   • 如果同时监控多个仓库，建议使用 PM2 等进程管理工具，避免 Node.js 进程意外终止。
   • 对于高流量仓库，可考虑部署 Redis 缓存，减少 GitHub API 的调用频率。
   
   

? 最佳实践

1. 建立规范：在团队中明确议题标签的使用规则，例如用 “bug” 表示缺陷，“feature” 表示新功能，方便通过过滤规则精准同步。
2. 权限分级：为不同角色的成员分配不同的 GitHub 权限，避免敏感操作触发不必要的通知。
3. 定期维护：每月检查 Webhook 的有效性，更新 Secret 密钥，并清理不再使用的群组配置。