在为 GitHub 应用编写代码之前,您应该注册一个 GitHub 应用。在注册 GitHub 应用时,您会选择该应用的权限。这些权限决定了 GitHub 应用可以做什么。在注册应用时,您还可以指定其他设置,包括 GitHub 应用应该接收哪些 Webhook 事件。您始终可以更改 GitHub 应用注册的设置。有关更多信息,请参阅“注册 GitHub 应用”和“修改 GitHub 应用注册”。
如果您希望 GitHub 应用访问存储库和/或组织数据,则需要安装 GitHub 应用。有关更多信息,请参阅“安装您自己的 GitHub 应用”。
为了让 GitHub 应用执行某些操作,您需要编写代码为 GitHub 应用添加功能。
有关如何为 GitHub 应用编写代码的教程,请参阅
你可以使用 GitHub 应用注册中的凭据对 GitHub 的 API 进行经过身份验证的请求。有关详细信息,请参阅“关于使用 GitHub 应用进行身份验证”。
在开发期间,你可能会使用个人计算机或 Codespace 来运行 GitHub 应用。在开发期间,你可能需要对 GitHub 应用注册进行一些修改
-
如果你的应用接收 Webhook,你可能希望使用 Webhook 代理 URL 将 Webhook 从 GitHub 转发到你的计算机或 Codespace。你需要更新 GitHub 应用注册中的“Webhook URL”设置,以使用你的 Webhook 代理 URL。有关示例,请参阅“构建响应 Webhook 事件的 GitHub 应用”。
-
如果你的应用使用 Web 应用程序流程来授权用户,你可能希望更新 GitHub 应用注册中的“回调 URL”设置,以使用本地回调 URL。有关示例,请参阅“使用 GitHub 应用构建“使用 GitHub 登录”按钮”。
为 GitHub 应用编写代码后,你应确保其遵循最佳实践。如有必要,请记住更新你的 GitHub 应用注册。如果你的 GitHub 应用需要在服务器上而不是用户设备上运行,请将你的应用部署到你的服务器。最后,你可以与其他用户和组织共享你的 GitHub 应用。
在部署 GitHub 应用之前,请确保遵循最佳实践。例如,确保你的 GitHub 应用的凭据是安全的。有关详细信息,请参阅“创建 GitHub 应用的最佳实践”。
如果你更改了用于开发的 GitHub 应用注册,请确保更新注册以使用适用于生产环境的值。例如,如果你在开发中使用了 Webhook 代理 URL,则应更新“Webhook URL”字段以使用你的 GitHub 应用在生产环境中接收 Webhook 的 URL。
编写 GitHub 应用的代码后,你的代码需要在某个地方运行。如果你的应用是网站或 Web 应用,则可以将应用托管在诸如 Azure 应用服务 之类的服务器上。如果你的应用是客户端应用,则它可能会在用户的设备上运行。
如果你想与其他用户和组织分享你的 GitHub 应用,则应公开你的 GitHub 应用。为了让你的 GitHub 应用更易于发现,你可以在 GitHub Marketplace 上列出它。有关更多信息,请参阅“分享你的 GitHub 应用”。