Skip to main content

修改 GitHub 应用注册

注册 GitHub App 后,可以对其进行更改。

关于 GitHub App 修改

可以修改 GitHub App 注册以最初更改注册应用时选择的任何设置。 有关在注册 GitHub App 时可以选择的设置的详细信息,请参阅“注册 GitHub 应用”。

例如,可以更改应用的名称和说明、授予应用的权限、应用订阅的 Webhook 或应用的可见性。

你还可以选择测试 GitHub App 的新可选功能。 有关详细信息,请参阅“激活 GitHub 应用的可选功能”。

导航到 GitHub App 设置

若要修改 GitHub App,请先导航到应用设置页面。

  1. 在 GitHub 上任意页的右上角,单击你的个人资料照片。
  2. 导航到您的帐户设置。
    • 对于由个人帐户拥有的应用,请单击“设置”****。
    • 对于组织拥有的应用:
      1. 单击“你的组织”。
      2. 在组织右侧,单击“设置”。
  3. 在左侧边栏中,单击“ 开发人员设置”。
  4. 在左侧边栏中,单击“GitHub Apps”。
  5. 在要修改的 GitHub App 右边,单击“编辑”。

更改 GitHub App 的基本信息

可以更改 GitHub App 的基本信息,例如应用的名称、应用的说明和应用的主页 URL。

  1. 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
  2. 在“基本信息”下,修改要更改的 GitHub App 信息。
  3. 单击“保存更改”。

在安装过程中请求用户授权 (OAuth)

在用户安装 GitHub App 时,可以提示用户对其进行授权,并生成用户访问令牌。 在安装过程中请求用户授权 (OAuth) 时,还必须提供回叫 URL,用户在授权安装后将重定向到该 URL。 有关详细信息,请参阅“为 GitHub 应用生成用户访问令牌”。

  1. 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
  2. 在“识别和授权用户”下,选择或取消选择“在安装过程中请求用户授权 (OAuth)”。
  3. 在“回叫 URL”下,输入用户授权安装后要重定向到的完整 URL。

启用或禁用设备流

可以使用设备流程授权用户使用无头应用,例如 CLI 工具或 Git 凭据管理器。 有关将设备流与 GitHub Apps 配合使用的详细信息,请参阅“为 GitHub 应用生成用户访问令牌”。

  1. 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
  2. 在“识别和授权用户”下,选择或取消选择“启用设备流”。

添加或更新安装 URL

安装应用后,可以将用户重定向到特定 URL。 有关详细信息,请参阅“注册 GitHub 应用”。

如果选择“在安装过程中请求用户授权 (OAuth)”,你将无法输入安装 URL。 用户将转而在授权流期间重定向到回叫 URL,你可在其中描述其他设置。 有关详细信息,请参阅“关于用户授权回调 URL”。

  1. 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
  2. 在“安装后”下的“安装 URL”字段中,输入用户安装应用后要重定向到的 URL。
  3. (可选)如果要在用户更新安装后将其重定向到设置 URL,请选择“更新时重定向”。 更新包括添加或删除安装的存储库。 如果“设置 URL”为空,这将被忽略。

更改 GitHub App 的权限

可以使用以下步骤更改授予 GitHub App 的访问权限。

更改应用的“存储库”或“组织”权限时,安装应用的每个帐户都需要批准新权限。 更改应用的“帐户”权限时,已授权应用的每个用户都需要批准权限更改。 在这两种情况下,GitHub 都会向每个组织所有者或用户发送电子邮件,通知他们更新应用权限的请求。 在批准新权限之前,更新的权限不会对安装或用户授权生效。 可以使用安装 Webhook 来了解用户何时接受应用的新权限。

更改应用的权限还可能会更改应用可以订阅的 Webhook 以及应用可以使用 API 执行的操作。 有关详细信息,请参阅“为 GitHub Apps 选择权限”。

  1. 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
  2. 在 GitHub Apps 设置边栏中,单击“权限和事件”。
  3. 在“存储库权限”、“组织权限”和“帐户权限”部分下,修改要更改的权限。 对于每种类型的权限,从下拉列表中选择“只读”、“读取和写入”或“无访问权限”。 有关详细信息,请参阅“为 GitHub Apps 选择权限”。
  4. (可选)在“向用户添加注释”下,添加注释,告诉用户为什么要更改 GitHub App 请求的权限。
  5. 单击“保存更改”。

激活或停用 GitHub App Webhook

可以将 GitHub App配置为接收 GitHub 上特定事件的 Webhook,并自动对其执行操作。 有关详细信息,请参阅“将 Webhook 与 GitHub 应用配合使用”。

  1. 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
  2. 在“Webhook”下,若要启用或禁用 Webhook,请选择或取消选择“活动”。
  3. 如果在上一步中选择了“活动”,则在“Webhook URL”下,输入 GitHub 应将 Webhook 事件发送到的 URL。
  4. (可选)如果在上一步中选择了“活动”,则在“Webhook 机密”下,输入用于保护 Webhook 的机密令牌。 GitHub 强烈建议设置 Webhook 机密。

更改 GitHub App 的 Webhook 事件订阅

可以使用以下步骤更改 GitHub App 订阅的 Webhook 事件。

可以为 GitHub App 注册选择的具体 Webhook 事件根据为应用选择的权限类型而定。 首先需要选择希望应用拥有的权限,然后可以让应用订阅与该权限集相关的 Webhook 事件。 有关详细信息,请参阅“将 Webhook 与 GitHub 应用配合使用”。

  1. 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
  2. 激活 GitHub App Webhook。 有关详细信息,请参阅本文中的“激活或停用 GitHub App Webhook”。
  3. 在 GitHub Apps 设置边栏中,单击“权限和事件”。
  4. 在“存储库权限”、“组织权限”和“帐户权限”部分下,选择应用将订阅的事件所需的权限。 有关详细信息,请参阅“更改 GitHub App 的权限”。
  5. 在“订阅事件”下,选择希望 GitHub App 接收的 Webhook 事件。
  6. 单击“保存更改”。

更改 GitHub App 的可见性

可以更改 GitHub App 的可见性设置,以控制谁可以安装它。 如果公共应用安装在其他帐户上,则不能将其设为专用应用。 有关详细信息,请参阅“将 GitHub 应用程序设为公共或私有”。

  1. 导航到要修改的应用的设置页面。 有关详细信息,请参阅本文中的“导航到 GitHub App 设置”。
  2. 在左侧边栏中,单击“高级”。
  3. 在“危险区域”下,根据 GitHub App 的当前可见性,单击“设为公用”或“设为专用” 。