关于注册 GitHub 应用
您可以在个人账户下、您拥有的组织下或已授予您管理组织所有应用权限的组织下注册 GitHub 应用。有关详细信息,请参阅“在组织中添加和删除 GitHub 应用管理员”。
用户或组织最多可以注册 100 个 GitHub 应用,但没有限制可以安装在账户上的 GitHub 应用数量。
注册 GitHub 应用
-
在 GitHub 上任何页面的右上角,单击您的个人资料照片。
-
导航到您的账户设置。
- 对于个人账户拥有的应用,单击设置。
- 对于组织拥有的应用
- 点击您的组织。
- 在组织的右侧,点击设置。
-
在左侧边栏中,点击 开发者设置。
-
在左侧边栏中,点击GitHub 应用。
-
点击新建 GitHub 应用。
-
在“GitHub 应用名称”下,输入您应用的名称。您应该选择一个清晰且简短的名称。名称不能超过 34 个字符。当您的应用执行操作时,您的应用名称(转换为小写,空格替换为
-
,特殊字符替换)将显示在用户界面中。例如,My APp Näme
将显示为my-app-name
。名称在 GitHub 中必须是唯一的。您不能使用与现有 GitHub 帐户相同的名称,除非它是您自己的用户或组织名称。
-
在“描述”下,可以选择输入您应用的描述。当用户和组织安装您的应用时,他们将看到此描述。
-
在“主页 URL”下,输入您应用网站的完整 URL。如果您没有专门的 URL,并且您的应用代码存储在公共存储库中,您可以使用该存储库 URL。或者,您可以使用拥有该应用的组织或用户的 URL。
-
在“回调 URL”下,可以选择输入在用户授权安装后重定向到的完整 URL。
您最多可以输入 10 个回调 URL。要添加其他回调 URL,请点击添加回调 URL。
如果您的应用不需要代表用户执行操作(不需要生成用户访问令牌),此字段将被忽略。如果您的应用使用设备流而不是 Web 应用程序流来生成用户访问令牌,此字段将被忽略。
有关回调 URL 的更多信息,请参阅“关于用户授权回调 URL”。有关代表用户生成用户访问令牌的更多信息,请参阅“代表用户使用 GitHub 应用进行身份验证”和“为 GitHub 应用生成用户访问令牌”。
-
或者,为了防止用户访问令牌过期,取消选择让用户授权令牌过期。GitHub 强烈建议您保持此选项处于选中状态。有关刷新过期令牌和用户访问令牌过期的优势的更多信息,请参阅“刷新用户访问令牌”。如果您的应用不需要生成用户访问令牌,此字段将被忽略。
-
或者,为了在用户安装应用时提示用户授权应用,选择在安装期间请求用户授权 (OAuth)。如果用户授权您的应用,您的应用可以生成用户访问令牌,以代表用户发出 API 请求,并将应用活动归因于用户。有关更多信息,请参阅“代表用户使用 GitHub 应用进行身份验证”和“为 GitHub 应用生成用户访问令牌”。
-
或者,如果您想使用设备流生成用户访问令牌,请选择启用设备流。有关更多信息,请参阅“为 GitHub 应用生成用户访问令牌”。
-
或者,在“设置 URL”下,输入在用户安装应用后将用户重定向到的 URL。如果在安装后需要进行其他设置,您可以使用此 URL 告诉用户在安装后采取哪些步骤。有关更多信息,请参阅“关于设置 URL”。
如果您在前面的步骤中选择了在安装期间请求用户授权 (OAuth),您将无法在此处输入 URL。相反,用户将作为授权流程的一部分被重定向到回调 URL,您可以在其中描述其他设置。
-
或者,如果您想在用户更新安装后将用户重定向到设置 URL,请选择在更新时重定向。更新包括为安装添加或移除存储库。如果“设置 URL”为空,这将被忽略。
-
如果不想让你的应用接收 webhook 事件,可以选择取消选择活动。例如,如果你的应用只用于身份验证或不需要响应 webhook,请取消选择此选项。有关更多信息,请参阅“使用 GitHub 应用的 webhook”。
-
如果你在上一步中选择了活动,请在“Webhook URL”下输入 GitHub 应向其发送 webhook 事件的 URL。有关更多信息,请参阅“使用 GitHub 应用的 webhook”。
-
如果你在上一步中选择了活动,可以选择在“Webhook 密钥”下输入一个密钥令牌来保护你的 webhook。GitHub 强烈建议你设置一个 webhook 密钥。有关更多信息,请参阅“使用 GitHub 应用的 webhook”。
-
如果你输入了 webhook URL,请在“SSL 验证”下选择是否启用 SSL 验证。GitHub 强烈建议你启用 SSL 验证。
-
在“权限”下,选择你的应用需要的权限。对于每个权限,选择下拉菜单并单击只读、读写或无访问权限。你应选择你的应用所需的最低权限。有关更多信息,请参阅“为 GitHub 应用选择权限”。
-
如果你在前面的步骤中选择了活动以表明你的应用应接收 webhook 事件,请在“订阅事件”下选择你希望你的应用接收的 webhook 事件。你在上一步中选择的权限决定了可用的 webhook 事件。有关每个 webhook 事件的更多信息,请参阅“Webhook 事件和有效负载”。
-
在“此 GitHub 应用可以在哪里安装?”下,选择仅此帐户或任何帐户。有关安装选项的更多信息,请参阅“使 GitHub 应用公开或私有”。
-
单击创建 GitHub 应用。
后续步骤
注册 GitHub 应用后,你需要编写代码让你的 GitHub 应用执行某些操作。有关如何编写代码的示例,请参阅
- "构建 GitHub 应用的快速入门"
- "构建响应 Webhook 事件的 GitHub 应用"
- "使用 GitHub 应用构建“使用 GitHub 登录”按钮"
- "使用 GitHub 应用构建 CLI"
- "在 GitHub Actions 工作流中使用 GitHub 应用进行经过身份验证的 API 请求"
您应遵循最佳实践。有关详细信息,请参阅“创建 GitHub 应用的最佳实践”。
完全构建 GitHub 应用后,您可以安装 GitHub 应用并与他人共享 GitHub 应用。有关详细信息,请参阅“安装您自己的 GitHub 应用”和“共享您的 GitHub 应用”。
您始终可以更改 GitHub 应用的设置。有关详细信息,请参阅“修改 GitHub 应用注册”。