跳至主要内容

关于编写 GitHub 应用代码

您需要编写代码才能为您的 GitHub 应用添加功能。

先决条件

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

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

为 GitHub App 编写代码

为了让您的 GitHub App 执行某些操作,您需要编写代码来为您的 GitHub App 添加功能。

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

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

在开发过程中,您可能会使用个人电脑或 Codespace 来运行您的 GitHub App。您可能需要在开发过程中修改 GitHub App 注册。

  • 如果您的应用接收 Webhook,您可能需要使用 Webhook 代理 URL 将 Webhook 从 GitHub 转发到您的电脑或 Codespace。您需要更新 GitHub App 注册中的“Webhook URL”设置以使用您的 Webhook 代理 URL。示例,请参阅“构建响应 Webhook 事件的 GitHub App”。

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

后续步骤

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

遵循最佳实践

在部署 GitHub App 之前,请确保您遵循最佳实践。例如,确保您的 GitHub App 的凭据安全。更多信息,请参阅“创建 GitHub App 的最佳实践”。

更新您的 GitHub App 注册

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

部署您的 GitHub App

编写完 GitHub App 的代码后,您的代码需要在某个地方运行。如果您的应用是网站或 Web 应用,您可以将应用托管在 Azure App Service 等服务器上。Azure App Service。如果您的应用是客户端应用,它可能在用户的设备上运行。

共享您的 GitHub App

如果要与其他用户和组织共享您的 GitHub App,则应将您的 GitHub App 设置为公开。为了使您的 GitHub App 更易于发现,您可以在 GitHub Marketplace 上列出它。更多信息,请参阅“共享您的 GitHub App”。