关于GitHub App的修改
可以修改 GitHub App 注册以更改最初注册应用时选择的任何设置。 有关注册 GitHub App时可以选择的设置的详细信息,请参阅 注册GitHub应用。
例如,可以更改应用的名称和说明、授予应用的权限、应用订阅的 Webhook 或应用的可见性。
你还可以选择为你的 GitHub App 测试新的可选功能。 请参阅“激活GitHub应用的可选功能”。
导航到设置GitHub App
若要修改GitHub App,请先前往应用设置页面。
-
在 GitHub 上任意页的右上角,单击你的个人资料图片。
-
导航到你的帐户设置。
- 对于由个人帐户拥有的应用,请单击“设置”****。
- 对于组织拥有的应用:
- 单击“你的组织”。
- 在组织的右侧,单击设置。
- 对于由企业拥有的应用:
- 如果使用的是 Enterprise Managed Users,请单击你的企业,以直接转到企业帐户设置。
- 如果使用的是个人帐户,请单击你的企业,然后单击企业右侧的设置。
-
导航到 GitHub App 设置。
- 对于由个人帐户或组织拥有的应用:
- 在左侧边栏中,单击“ Developer settings”,然后单击“GitHub Apps”********。
- 对于由企业拥有的应用:
- 在左侧边栏中,在“设置”下,单击 GitHub Apps。
- 对于由个人帐户或组织拥有的应用:
-
在要修改的 GitHub App 右边,单击“编辑”。
更改GitHub App的基本信息
可以更改你的 GitHub App基本信息,例如应用的名称、应用的说明和应用的主页 URL。
- 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
- 在“基本信息”下,修改您想更改的 GitHub App 信息。
- 单击“保存更改”。
在安装过程中请求用户授权 (OAuth)
你可以在用户安装你的 GitHub App 时提示其进行授权,并生成用户访问令牌。 在安装过程中请求用户授权 (OAuth) 时,还必须提供回叫 URL,用户在授权安装后将重定向到该 URL。 请参阅“为 GitHub 应用生成用户访问令牌”。
- 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
- 在“识别和授权用户”下,选择或取消选择“在安装过程中请求用户授权 (OAuth)”。
- 在“回叫 URL”下,输入用户授权安装后要重定向到的完整 URL。
启用或禁用设备流
可以使用设备流程授权用户使用无头应用,例如 CLI 工具或 Git 凭据管理器。 有关如何将设备流与 GitHub Apps 结合使用的详细信息,请参阅 为 GitHub 应用生成用户访问令牌。
- 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
- 在“识别和授权用户”下,选择或取消选择“启用设备流”。
添加或更新安装 URL
安装应用后,可以将用户重定向到特定 URL。 请参阅“注册GitHub应用”。
如果选择“在安装过程中请求用户授权 (OAuth)”,你将无法输入安装 URL。 用户将转而在授权流期间重定向到回叫 URL,你可在其中描述其他设置。 请参阅“关于用户授权回调 URL”。
- 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
- 在“安装后”下的“安装 URL”字段中,输入用户安装应用后要重定向到的 URL。
- (可选)如果要在用户更新安装后将其重定向到设置 URL,请选择“更新时重定向”。 更新包括添加或删除安装的存储库。 如果“设置 URL”为空,这将被忽略。
更改GitHub App的权限
您可以按照以下步骤更改授予 GitHub App 的访问权限。
为应用添加新 的存储库、 组织或 企业 权限时,安装应用的每个帐户都需要批准新权限。 为应用添加帐户权限时,每个已授权该应用的用户都需要批准权限更改。**** 在这两种情况下, GitHub 都会向每个组织所有者或用户发送电子邮件,通知他们更新应用权限的请求。 在批准新权限之前,更新的权限不会对安装或用户授权生效。 可以使用安装 Webhook 来了解用户何时接受应用的新权限。
如果您从您的 GitHub App 中移除权限或 Webhook,这些更改将立即生效。 如果删除以前授予应用的权限,应用将不再能够访问这些资源。
如果更改企业拥有的应用的权限,则如果你是企业所有者,这些更改将立即对企业 内应用的所有安装生效。 如果你是应用管理员,则这些更改只会在你是组织所有者的组织中被自动接受。
如果首次向应用添加仓库权限,则无法自动接受更新。 在这种情况下,每个组织所有者都需要批准更新,以便他们可以选择应用有权访问的存储库。
更改应用的权限还可能会更改应用可以订阅的 Webhook 以及应用可以使用 API 执行的操作。 请参阅“为GitHub应用选择权限”。
- 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
- 在 GitHub Apps 设置边栏中,单击 “权限和事件”。
- 在“存储库权限”、“组织权限”和“帐户权限”部分下,修改要更改的权限。 对于每种类型的权限,从下拉列表中选择“只读”、“读取和写入”或“无访问权限”。 请参阅“为GitHub应用选择权限”。
- 您也可以在“向用户添加备注”下添加一则备注,向用户说明您为什么要更改您的 GitHub App 所请求的权限。
- 单击“保存更改”。
激活或停用 GitHub App Webhook
你可以配置你的 GitHub App,使其接收来自 GitHub 上特定事件的 Webhook,并自动对这些事件执行操作。 请参阅“将 Webhook 与 GitHub 应用配合使用”。
- 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
- 在“Webhook”下,若要启用或禁用 Webhook,请选择或取消选择Active。
- 如果您在上一步中选择了 Active,请在“Webhook URL”下方输入 GitHub 应将 webhook 事件发送到的 URL。
- 可选:如果你在上一步选择了“启用”,在“Webhook 密钥”下输入一个密钥令牌以保护你的 webhook。 GitHub 强烈建议您设置 Webhook 密钥。
更改GitHub App的 Webhook 事件订阅
您可以使用以下步骤更改 GitHub App 订阅的 Webhook 事件。
可以为 GitHub App 注册选择的具体 Webhook 事件根据为应用选择的权限类型而定。 首先需要选择希望应用拥有的权限,然后可以让应用订阅与该权限集相关的 Webhook 事件。 请参阅 将 Webhook 与 GitHub 应用配合使用。
- 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
- 启用GitHub AppWebhook。 请参阅本文中的激活或停用GitHub App webhook。
- 在 GitHub Apps 设置边栏中,单击 “权限和事件”。
- 在“存储库权限”、“组织权限”和“帐户权限”部分下,选择应用将订阅的事件所需的权限。 请参阅更改某个GitHub App的权限。
- 在“订阅事件”下,选择你希望 GitHub App 接收的 Webhook 事件。
- 单击“保存更改”。
更改GitHub App的可见性
您可以更改您的 GitHub App 的可见性设置,以控制哪些人可以安装它。 如果公共应用安装在其他帐户上,则不能将其设为专用应用。 请参阅“将GitHub应用公开或专用”。
无法更改企业拥有的 GitHub App 的可见性。 GitHub Apps由企业拥有的内容只能安装到企业内部的组织或企业本身。
- 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
- 在左侧边栏中,单击“高级”。
- 在“危险区域”下,根据 GitHub App 当前的可见性,点击 “设为公开” 或 “设为专用”。