Skip to main content

此版本的 GitHub Enterprise Server 将于以下日期停止服务 2024-08-29. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

关于为 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 应用进行身份验证”。

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

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

  • 如果你的应用使用 Web 应用程序流来授权用户,你可能希望更新 GitHub App 注册中的“回叫 URL”设置,以使用本地回叫 URL。 有关示例,请参阅“使用 GitHub Apps 生成“使用 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 应用”。