关于 GitHub 应用修改
您可以修改您的 GitHub 应用注册信息,更改应用最初注册时选择的任何设置。有关注册 GitHub 应用时可以选择哪些设置的更多信息,请参阅“注册 GitHub 应用”。
例如,您可以更改应用的名称和描述、授予应用的权限、应用订阅的 Webhook 或应用的可见性。
您还可以选择测试 GitHub 应用的新可选功能。请参阅“激活 GitHub 应用的可选功能”。
导航到您的 GitHub 应用设置
要修改 GitHub 应用,首先导航到应用设置页面。
-
在 GitHub 上任何页面的右上角,单击您的个人资料照片。
-
导航到您的帐户设置。
- 对于个人帐户拥有的应用,单击设置。
- 对于组织拥有的应用
- 单击您的组织。
- 在组织的右侧,单击设置。
-
在左侧边栏中,单击 开发者设置。
-
在左侧边栏中,单击GitHub 应用。
-
在您想要修改的 GitHub 应用的右侧,单击编辑。
更改 GitHub 应用的基本信息
您可以更改 GitHub 应用的基本信息,例如应用名称、应用描述和应用主页 URL。
- 导航到您要修改的应用的设置页面。更多信息,请参阅本文中的“导航到您的 GitHub 应用设置”。
- 在“基本信息”下,修改您想要更改的 GitHub 应用信息。
- 单击保存更改。
安装期间请求用户授权 (OAuth)
您可以提示用户在安装应用时授权您的 GitHub 应用并生成用户访问令牌。当您在安装期间请求用户授权 (OAuth) 时,还必须提供一个回调 URL,用户将在授权安装后重定向到该 URL。请参阅“生成 GitHub 应用的用户访问令牌”。
- 导航到您要修改的应用的设置页面。更多信息,请参阅本文中的“导航到您的 GitHub 应用设置”。
- 在“标识和授权用户”下,选中或取消选中安装期间请求用户授权 (OAuth)。
- 在“回调 URL”下,输入用户授权安装后要重定向到的完整 URL。
启用或禁用设备流
您可以使用设备流来授权无头应用(如 CLI 工具或 Git 凭据管理器)的用户。有关将设备流与 GitHub 应用一起使用的更多信息,请参阅“生成 GitHub 应用的用户访问令牌”。
- 导航到您要修改的应用的设置页面。更多信息,请参阅本文中的“导航到您的 GitHub 应用设置”。
- 在“标识和授权用户”下,选中或取消选中启用设备流。
添加或更新安装 URL
用户安装您的应用后,您可以将其重定向到特定 URL。请参阅“注册 GitHub 应用”。
如果您选择安装期间请求用户授权 (OAuth),则无法输入安装 URL。相反,用户将作为授权流程的一部分重定向到回调 URL,您可以在其中描述其他设置。请参阅“关于用户授权回调 URL”。
- 导航到您要修改的应用的设置页面。更多信息,请参阅本文中的“导航到您的 GitHub 应用设置”。
- 在“安装后”下的“安装 URL”字段中,输入您希望在用户安装应用后将其重定向到的 URL。
- 可选:如果您希望在用户更新安装后将其重定向到安装 URL,请选择更新时重定向。更新包括为安装添加或删除存储库。如果“安装 URL”为空,则将忽略此选项。
更改 GitHub 应用的权限
您可以按照以下步骤更改授予 GitHub 应用的访问权限。
当您更改应用的存储库或组织权限时,安装了该应用的每个帐户都需要批准新的权限。当您更改应用的帐户权限时,每个已授权该应用的用户都需要批准权限更改。在这两种情况下,GitHub 都会向每个组织所有者或用户发送一封电子邮件,通知他们更新应用权限的请求。在批准新的权限之前,更新的权限不会在安装或用户授权上生效。您可以使用安装 Webhook 了解人们何时接受应用的新权限。
更改应用的权限也可能会更改应用可以订阅的 Webhook 和应用可以使用 API 执行的操作。请参阅“为 GitHub 应用选择权限”。
- 导航到您要修改的应用的设置页面。更多信息,请参阅本文中的“导航到您的 GitHub 应用设置”。
- 在 GitHub 应用设置侧边栏中,单击权限和事件。
- 在“存储库权限”、“组织权限”和“帐户权限”部分下,修改您想要更改的权限。对于每种类型的权限,从下拉列表中选择“只读”、“读写”或“无访问权限”。请参阅“为 GitHub 应用选择权限”。
- 可选:在“向用户添加说明”下,添加说明,告诉您的用户您更改 GitHub 应用请求的权限的原因。
- 单击保存更改。
激活或停用 GitHub 应用 Webhook
您可以将 GitHub 应用配置为接收 GitHub 上特定事件的 Webhook 并自动对其采取措施。请参阅“将 Webhook 与 GitHub 应用一起使用”。
- 导航到您要修改的应用的设置页面。更多信息,请参阅本文中的“导航到您的 GitHub 应用设置”。
- 在“Webhook”下,要启用或禁用 Webhook,请选中或取消选中活动。
- 如果您在上一步中选择了活动,请在“Webhook URL”下输入 GitHub 应将 Webhook 事件发送到的 URL。
- 可选:如果您在上一步中选择了活动,请在“Webhook 密钥”下输入密钥令牌以保护您的 Webhook。GitHub 强烈建议您设置 Webhook 密钥。
更改 GitHub 应用的 Webhook 事件订阅
您可以按照以下步骤更改 GitHub 应用订阅的 Webhook 事件。
您可以为 GitHub 应用注册选择的特定 Webhook 事件取决于您为应用选择的权限类型。您首先需要选择您希望应用具有的权限,然后您可以将应用订阅到与该权限集相关的 Webhook 事件。请参阅“将 Webhook 与 GitHub 应用一起使用”。
- 导航到您要修改的应用的设置页面。更多信息,请参阅本文中的“导航到您的 GitHub 应用设置”。
- 激活 GitHub 应用 Webhook。请参阅本文中的“激活或停用 GitHub 应用 Webhook”。
- 在 GitHub 应用设置侧边栏中,单击权限和事件。
- 在“存储库权限”、“组织权限”和“帐户权限”部分下,选择应用将订阅的事件所需的权限。请参阅“更改 GitHub 应用的权限”。
- 在“订阅事件”下,选择您希望 GitHub 应用接收的 Webhook 事件。
- 单击保存更改。
更改 GitHub 应用的可见性
您可以更改 GitHub 应用的可见性设置,以控制谁可以安装它。如果公共应用已安装在其他帐户上,则无法将其设为私有。请参阅“使 GitHub 应用公开或私有”。
- 导航到您要修改的应用的设置页面。更多信息,请参阅本文中的“导航到您的 GitHub 应用设置”。
- 在左侧边栏中,单击高级。
- 在“危险区域”下,根据 GitHub 应用的当前可见性,单击设为公开或设为私有。