连接 GitHub Issues: 分步指南
为每个失败的测试创建一个 GitHub 议题, 测试再次失败时在该议题下添加评论, 测试顺利通过时关闭议题. GitHub 不接受文件上传, 因此议题中会注明证据文件夹, 而不是附上截图. 本指南将带您从零开始完成连接并验证, 同时列出您可能遇到的错误及其原因和解决方法.
最后更新:
请妥善保管您的凭据。切勿将令牌、密钥、密码或 Webhook URL 粘贴到聊天中。请仅在 Studio → 设置 → 集成中输入,凭据会保存到工作区的 .env 文件中,并以圆点显示。对 AI 助手也是如此: 它可以指导您完成本指南中的步骤,但绝不需要您的令牌。
所需准备
- 一个有权在仓库中创建议题的 GitHub 账号 (协作者或所有者).
- 一个已启用议题功能的仓库 (仓库设置 → 功能 → 议题).
- 一个对该仓库具有“议题 → 读写”权限的细粒度个人访问令牌, 或一个具有 repo 权限范围的经典令牌.
获取凭据
- 打开 https://github.com/settings/personal-access-tokens/new (创建细粒度令牌).
- 为令牌命名并设置到期时间, 在“仓库访问权限”下选择“仅选择指定仓库”, 然后选择用于接收议题的仓库.
- 在权限 → 仓库权限下, 将“议题”设为“读写”. 无需其他权限.
- 生成令牌后立即复制. GitHub 只会显示一次. 除 Studio 外, 不要将其粘贴到其他任何地方 (见下一步).
在 Studio 中连接
- 在 Studio 中, 打开设置 → 集成 → 连接 GitHub Issues.
- 出现提示时, 输入令牌并点击保存 & 检查. Studio 会显示令牌所属用户及其可访问的仓库数量.
- 在"议题目标仓库"中选择仓库. 列表仅显示令牌可访问且已启用议题功能的仓库.
- 启用
GITHUB_ISSUES_ENABLED.
验证连接是否正常
- “检查连接”会显示"已以 <you> 身份登录"和"<owner/repo> 可接收议题". 此检查仅执行读取操作, 不会创建议题.
- 打开设置 → 集成 → 工单, 在 GitHub 目标位置点击“创建测试工单”. 这会创建一个带有 nexus-test 标签的议题.
- 在 GitHub 上打开该议题, 确认标签, 完成后将其关闭或删除.
常见错误
| 你看到的现象 | 原因 | 解决方法 |
|---|---|---|
| "GitHub 拒绝了令牌 (401)" | 令牌不正确、已过期、已撤销或复制不完整. | 创建一个具有“议题 → 读写”权限的新令牌, 然后重新保存. |
| HTTP 403 | 令牌缺少议题权限、未为其选择该仓库, 或请求次数已达上限. | 编辑令牌: 将“议题”设为“读写”并选择该仓库. 如果是请求次数限制, 请等待几分钟. |
| HTTP 404 | 仓库不存在、已重命名, 或令牌无法访问该仓库 (使用细粒度令牌时, 必须选择相应的私有仓库). | 从列表中选择仓库, 或将其添加到令牌的仓库访问权限中. |
| HTTP 422 | GitHub 拒绝了议题的某个字段, 最常见的情况是被指派人不是协作者, 或标题或标签不被 GitHub 接受. | 在设置 → 集成 → 工单中清除被指派人, 或将此人添加为协作者. |
| "<repo> 已关闭议题功能" | 该仓库已禁用议题功能. | 在仓库的设置 → 功能 → 议题中启用该功能, 或选择其他仓库. |
| "无法连接 GitHub (…)"或"未及时响应" | 此电脑无法连接 api.github.com: 原因可能是 VPN、代理或没有网络连接. | 在同一台电脑上使用浏览器打开 github.com, 然后重试检查. |
| 所有检查均通过, 但没有出现议题 | GITHUB_ISSUES_ENABLED 为 false; 或判定结果为 FLAKY 或环境问题; 或本次为沙盒运行; 或该测试已有未关闭的议题 (再次失败时会改为添加评论). | 启用 GITHUB_ISSUES_ENABLED, 并使用“创建测试工单”验证连接. |
设置键
| 键 | 功能 | 有效值 | 如何检查 |
|---|---|---|---|
GITHUB_ISSUES_ENABLED | 为失败项创建 GitHub 议题 | true 或 false | 检查连接通过后启用,然后运行创建测试工单。 |
GITHUB_ISSUES_TOKEN | GitHub 访问令牌 (机密, 仅保存在此电脑上) | 单行,不带引号,不含空格 | 检查连接: "令牌被拒绝"表示令牌错误、已过期或已撤销. |
GITHUB_ISSUES_REPO | 用于接收议题的 GitHub 仓库 | 所有者/仓库, 如 acme/web | 从列表中选择; Studio 只会保存令牌可访问且已启用 Issues 的仓库. |
更多: 所有集成, 设置指南, 故障排查. 其他指南: Jira Cloud, Azure Boards, Slack, Microsoft Teams, Telegram.
仍然遇到问题?请发送邮件至 [email protected],附上 Studio 显示的完整错误行。请勿包含令牌。