Skip to main content

关于为GitHub应用编写代码

需要编写代码以将功能添加到您的 GitHub App.

在本文中

先决条件

在为 GitHub App 编写代码之前,应注册一个 GitHub App。 当你注册 GitHub App 时,你可以为该应用选择权限。 这些权限决定了 GitHub App 可以执行的操作。 注册应用时,还需要指定其他设置,包括你的 GitHub App 应接收哪些 Webhook 事件。 您始终可以更改您的 GitHub App 注册设置。 有关详细信息,请参阅 注册GitHub应用修改GitHub应用注册

如果您希望您的GitHub App访问仓库和/或组织数据,则需要安装您的GitHub App。 有关详细信息,请参阅“安装自己的GitHub应用”。

为 GitHub App 编写代码

若要 GitHub App 执行某些操作,需要编写代码以将功能添加到您的 GitHub App。

有关如何为 GitHub App 编写代码的教程,请参阅:

您可以使用您的 GitHub App 注册凭据向 GitHub 的 API 发出经过身份验证的请求。 有关详细信息,请参阅“关于使用 GitHub 应用进行身份验证”。

在开发过程中,你可能使用个人计算机或代码空间来运行你的 GitHub App。 在开发过程中,可能需要对 GitHub App 注册进行一些修改:

  • 如果你的应用接收 webhook,你可能希望使用代理服务器 URL 将 webhook 从 GitHub 转发到你的计算机或代码空间。 您需要在您的 GitHub App 注册中更新“Webhook URL”设置,使其使用您的 webhook 代理 URL。 有关示例,请参阅 构建响应 Webhook 事件的GitHub应用

  • 如果你的应用使用 Web 应用程序流来授权用户,则可能需要更新注册中的 GitHub App “回调 URL”设置,以使用本地回调 URL。 有关示例,请参阅 使用 GitHub 应用生成“使用 GitHub 登录”按钮

后续步骤

编写 GitHub App代码后,应确保它遵循最佳做法。 如有必要,请记得更新 GitHub App 注册。 如果您的 GitHub App 需要在服务器上运行,而不是在用户设备上运行,请将您的应用部署到您的服务器上。 最后,您可以与其他用户和组织共享您的GitHub App。

遵循最佳做法

在部署 GitHub App之前,请确保遵循最佳做法。 例如,请确保你的 GitHub App 凭据安全。 有关详细信息,请参阅“创建GitHub应用的最佳做法”。

更新您的GitHub App注册信息

如果您为了开发而更改了 GitHub App 注册,请确保将该注册更新为使用可用于生产环境的值。 例如,如果使用 Webhook 代理 URL 进行开发,则应更新“Webhook URL”字段以使用希望在 GitHub App 生产期间接收 Webhook 的 URL。

部署您的 GitHub App

编写好 GitHub App 的代码后,这些代码需要在某处运行。 如果你的应用是网站或 Web 应用,则可以在Azure 应用服务等服务器上托管应用。 如果你的应用是客户端应用,它可能会在用户的设备上运行。

分享你的 GitHub App

如果你想与其他用户和组织共享你的 GitHub App,你应该将你的 GitHub App 设为公开。 为了让你的 GitHub App 更容易被发现,你可以将其列在 GitHub Marketplace 上。 有关详细信息,请参阅 共享 GitHub 应用