为 OpenConnector 创建 GitHub OAuth app

OpenConnector 需要用户授权的 GitHub 连接时，使用 GitHub OAuth app。GitHub 也支持 personal access token；如果你希望走授权流程，而不是手动粘贴 token，OAuth 更合适。

OpenConnector service

OpenConnector 的 GitHub OAuth provider 可能请求 read:user、user:email、repo、workflow 和 delete_repo 等 scopes。只授予你计划运行的 actions 所需 scopes。

前置条件

• 一个正在运行的 OpenConnector runtime。
• 一个可以创建 OAuth apps 的 GitHub 账号或 organization。
• 用户在浏览器中打开的 OpenConnector origin，例如 http://localhost:3000 或 https://connect.example.com。

第 1 步：确定 OpenConnector callback URL

在 OpenConnector origin 后拼接 /oauth/callback，得到 callback URL。本地测试使用 http://localhost:3000/oauth/callback。公开部署时，请先设置 OOMOL_CONNECT_ORIGIN，重启 OpenConnector 后使用公开 callback URL，例如 https://connect.example.com/oauth/callback。

第 2 步：注册 GitHub OAuth app

在 GitHub 中：

1. 打开 Settings。
2. 打开 Developer settings。
3. 打开 OAuth Apps。
4. 选择 New OAuth App。
5. 填写 app name 和 homepage URL。
6. 将 Authorization callback URL 设置为 OpenConnector 的准确 callback URL。
7. 注册 app。

GitHub 官方文档见 Creating an OAuth app。GitHub OAuth app 只有一个 authorization callback URL；如果 local、staging 和 production 使用不同 callback URL，建议创建多个 app。

第 3 步：复制 client credentials

从 GitHub OAuth app 页面复制：

第 4 步：在 OpenConnector 中保存 GitHub client

优先使用 OpenConnector Web 控制台：

1. 打开 OpenConnector Web 控制台，例如 http://localhost:3000。
2. 打开 Providers，选择 GitHub。
3. 点击 Configure OAuth Client 或 Edit OAuth Client。
4. 粘贴 GitHub client ID 和 client secret。
5. 点击 Save OAuth Client。

第 5 步：连接并测试

保存 OAuth client 后，在 GitHub provider 页面点击 Connect。批准 GitHub OAuth app，回到 OpenConnector，并确认 provider 页面显示账号已连接。

可在控制台 action 列表中运行 github.get_current_user 做低风险测试。

排查建议