创建 GitHub 应用程序

您可以在您的个人帐户下或在您有管理权限的任何组织下创建和注册 GitHub 应用程序。

  1. 导航到您的帐户设置。

    • 对于用户帐户拥有的 GitHub 应用程序,在任何页面的右上角,单击您的个人资料照片,然后单击 Settings(设置)用户栏中的 Settings 图标
    • 对于组织拥有的 GitHub 应用程序,在任何页面的右上角,单击您的个人资料照片,然后单击 Your organizations(您的组织)。 然后,在组织右边,单击 Settings(设置)个人资料菜单中的组织 设置按钮
  2. 在左侧边栏中,单击 Developer settingsDeveloper settings 部分

  3. 在左侧边栏中,单击 GitHub Apps(GitHub 应用程序)GitHub Apps 部分

  4. 单击 New GitHub App(新建 GitHub 应用程序)用于创建新 GitHub 应用程序的按钮

  5. 在“GitHub App name(GitHub 应用程序名称)”中,输入应用程序的名称。 GitHub 应用程序名称字段

    给应用程序一个清晰简洁的名称。 应用程序不能与现有 GitHub 帐户同名,除非它是您自己的用户或组织的名称。 当您的集成执行操作时,应用程序名称的缓存版本将显示在用户界面上。

  6. (可选)在“Description(说明)”中,输入用户将看到的应用程序说明。 GitHub 应用程序说明字段

  7. 在“Homepage URL(主页 URL)”中,输入应用程序网站的完整 URL。 GitHub 应用程序主页 URL 字段

  8. 在“User authorization callback URL(用户授权回调 URL)”中,键入用户授权安装后要重定向到的完整 URL。 如果应用程序需要识别和授权用户到服务器的请求,则使用此 URL。 GitHub 应用程序的用户授权回调 URL 字段

  1. 默认情况下,为了提高应用程序的安全性,应用程序将使用过期用户授权令牌。 要选择不使用过期用户令牌,您必须取消选中“Expire user authorization tokens(过期用户授权令牌)”。 要了解有关设置刷新令牌流程和过期用户令牌的好处,请参阅“刷新用户到服务器的访问令牌”。 在 GitHub 应用程序设置过程中选择加入过期用户令牌的选项

  2. 如果应用程序授权用户使用 OAuth 流程,您可以选择在安装过程中请求用户授权 (OAuth),以允许用户在安装应用程序时授权它,从而省去一个步骤。 如果您选择此选项,则“设置 URL”将不可用,用户在安装应用程序后将被重定向到您的“用户授权回调 URL”。 更多信息请参阅“在安装过程中授权用户”。 安装过程中请求用户授权

  3. 如果安装后需要附加设置,请添加一个“设置 URL”以便在用户安装应用程序后重定向他们。 GitHub 应用程序的设置 URL 字段

    注:如果您在上一步选择了在安装过程中请求用户授权 (OAuth),此字段将不可用,用户在安装应用程序后将被重定向到“用户授权回调 URL”。

  4. 在“Webhook URL(Web 挂钩 URL)”中,输入事件将 POST 到的 URL。 每个应用程序都会收到自己的 web 挂钩(每当应用程序被安装或修改时都会通知您)以及应用程序订阅的任何其他事件。 GitHub 应用程序的 web 挂钩 URL 字段

  5. (可选)在“Webhook Secret(Web 挂钩密钥)”中,输入用于保护 web 挂钩的可选密钥令牌。 添加 web 挂钩密钥令牌的字段

    注:我们强烈建议您设置密钥令牌。 更多信息请参阅“保护 web 挂钩”。

  6. 在“Permissions(权限)”中,选择应用程序将请求的权限。 对于每种类型的权限,请使用下拉菜单并单击 Read-only(只读)Read & write(读取和写入)No access(无访问权限)GitHub 应用程序的各种权限

  7. 在“Subscribe to events(订阅事件)”中,选择您想要应用程序接收的事件。

  8. 要选择可安装应用程序的位置,请选择 Only on this account(仅在此帐户上)Any account(任何帐户)。 有关安装选项的更多信息,请参阅“将 GitHub 应用程序设为公开或私有”。 GitHub 应用程序的安装选项

  9. 单击 Create GitHub App(创建 GitHub 应用程序)创建 GitHub 应用程序的按钮

此文档对您有帮助吗?隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。