cn 我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

此版本的 GitHub Enterprise 将停止服务 2021-02-11. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

设置开发环境以创建 GitHub 应用程序

了解扩展和构建新 GitHub 应用程序 的基础。

本文内容

简介

本指南将演练配置 GitHub 应用程序并在服务器上运行它所需的步骤。 GitHub 应用程序需要一些设置步骤来管理 web 挂钩事件并将 GitHub 上的应用程序注册连接到您的代码。 本指南中的应用程序可用作扩展和构建新 GitHub 应用程序的基础。

在本指南结束之前,您将注册 GitHub 应用程序并设置 web 服务器以接收 web 挂钩事件。 您将学习如何使用名为 Smee 的工具捕获 web 挂钩有效负载,并将它们转发到本地开发环境。 您将在本节中配置的模板应用不会做任何特殊的事情,但它将作为一个框架,支持您使用 API 开始编写应用程序代码或完成其他快速入门指南

完成此项目后,您将了解如何验证为 GitHub 应用程序和安装设施,以及这些身份验证方法有何不同。

以下是配置模板 GitHub 应用程序的步骤:

  1. 启动新的 Sme 通道
  2. 注册新的 GitHub 应用程序
  3. 保存私钥和应用程序 ID
  4. 准备运行时环境
  5. 审查 GitHub 应用程序模板代码
  6. 启动服务器
  7. 在您的帐户上安装应用程序

注:本指南演示了使用 Ruby 编程语言的应用程序开发过程。 但有很多Octokit 风格。 如果您喜欢 JavaScript,可以使用 ProbotNode.js 开发 GitHub 应用程序。

基本要求

您可能会发现对以下内容有基本的了解很有帮助:

但是,任何经验水平都能跟上步伐。 我们会一路提供所需信息的链接。

在开始之前,您需要使用本快速入门中所用的模板代码克隆仓库。 打开您的终端应用程序并找到要存储代码的目录。 运行此命令以克隆 GitHub 应用程序模板仓库:

$ git clone https://github.com/github-developer/github-app-template.git

步骤 1. 启动新的 Sme 通道

为了帮助 GitHub 将 web 挂钩发送到您的本地计算机而不将其暴露在互联网上,您可以使用一个名为 Smee 的工具。 首先,转到 https://smee.io,然后单击 Start a new channel(启动新通道)。 如果您已经习惯使用将本地计算机暴露到互联网上的其他工具,例如 ngroklocaltunnel,请随意使用。

Smee 新通道按钮

启动一个新的 Smee 通道并创建一个唯一的域,供 GitHub 发送 web 挂钩有效负载。 下一步需要了解此域。 以下是 https://smee.io/qrfeVRbFbffd6vD 上的唯一域示例:

Smee 唯一通道

接下来,返回终端并按照以下步骤运行 Smee 命令行接口 (CLI) 客户端:

注:以下步骤与您在 Smee 通道页面中看到的“使用 CLI”说明略有不同。 您需要遵循“使用 Node.js 客户端”或“使用 Probot 的内置支持”说明。

  1. 安装客户端:

    $ npm install --global smee-client
  2. 运行客户端(将 https://smee.io/qrfeVRbFbffd6vD 替换为自己的域):

    $ smee --url https://smee.io/qrfeVRbFbffd6vD --path /event_handler --port 3000

    您应该会看到如下输出:

    Forwarding https://smee.io/qrfeVRbFbffd6vD to http://127.0.0.1:3000/event_handler
    Connected https://smee.io/qrfeVRbFbffd6vD

smee --url <unique_channel> 命令指示 Smee 将 Smee 通道接收的所有 web 挂钩事件转发到计算机上运行的 Smee 客户端。 --path /event_handler 选项将事件转发到 /event_handler 路由,我们将在后面的章节中介绍。 --port 3000 选项指定端口 3000,这是服务器将侦听的端口。 使用 Smee,您的计算机不需要向公共互联网开放即可从 GitHub 接收 web 挂钩。 您也可以在浏览器中打开 Smee URL 来检查 web 挂钩有效负载。

我们建议您在完成本指南其余步骤时保持此终端窗口打开并保持 Smee 连接。 尽管您可以断开连接后重新连接 Smee 客户端而不会丢失唯一域(与 ngrok 不同),但您可能会发现,保持连接时在其他终端窗口中执行其他命令行任务更容易。

步骤 2. 注册新的 GitHub 应用程序

如果您还没有 GitHub 帐户,现在是时候注册了。 在继续之前,不要忘记验证您的电子邮件地址! 要注册新应用程序,请访问您的 GitHub 个人资料中的应用程序设置页面,然后单击 New GitHub App(新建 GitHub 应用程序)

GitHub 网站,显示 **新应用程序**

您将看到一个表单,您可以在其中输入有关应用程序的详细信息。 有关此页面上字段的一般信息,请参阅“创建 GitHub 应用程序”。 在本指南中,您需要在几个字段中输入特定数据:

注:您以后可以随时更新这些设置以指向托管服务器。

  • 对于“主页 URL”,请使用 Smee 发布的域名。 例如:

    为主页 URL 填写 Smee 域的表单

  • 对于“web 挂钩 URL”,也请使用 Smee 发布的域名。 例如:

    为 web 挂钩 URL 填写 Smee 域的表单

  • 对于“web 挂钩密钥”,请创建密码来保护您的 web 挂钩端点。 这应该是只有您(和 GitHub 通过此表单)知道的密码。 此密钥很重要,因为您将从公共互联网接收有效负载,并且您将使用此密钥来验证 web 挂钩发送者。 请注意,GitHub 应用程序设置表示 web 挂钩密钥是可选的,在大多数情况下确实如此,但要使模板应用程序代码正常工作,您必须设置 web 挂钩密钥。

    填写 web 挂钩密钥的表单

  • 在 Permissions & Webhooks(权限和 web 挂钩)页面上,您可以为应用程序指定一组权限,这些权限决定了应用程序有权访问多少数据。 保留此页面的默认值。 如果您决定扩展此模板应用程序,可以在以后更新这些权限。

  • 在 Permissions & Webhooks(权限和 web 挂钩)页面的底部,指定这是私有应用程序还是公共应用程序。 这是指谁可以安装它:是只有您自己,还是世界上任何人? 现在,选择 Only on this account(仅在此帐户上)将应用程序保留为私有应用程序。

    GitHub 应用程序隐私

单击 Create GitHub App(创建 GitHub 应用程序)以创建您的应用程序!

步骤 3. 保存私钥和应用程序 ID

创建应用程序后,您将被带回应用程序设置页面。 您还有两件事要做:

  • 为应用程序生成私钥。这是以后验证应用程序所必需的。 向下滚动页面,然后单击 Generate a private key(生成私钥)。 将生成的 PEM 文件(称为 app-name-date-private-key.pem 等)保存在可以再次找到的目录中。

    私钥生成对话框

  • 请注意 GitHub 已为您的应用程序分配了应用程序 ID。您需要使用它来准备运行时环境。

    应用程序的 ID

步骤 4. 准备运行时环境

为了保证您的信息安全,我们建议将与应用程序相关的所有密钥放在应用程序可以找到的计算机内存中,而不是直接将它们放在代码中。 一种称为 dotenv 的便捷开发工具将特定于项目的环境变量从 .env 文件加载到 ENV。 切勿将 .env 文件检入 GitHub。 这是一个本地文件,用于存储您不希望在公共互联网上公开的敏感信息。 为了防止这种情况,.env 文件已包含在仓库的 .gitignore 文件中。

您在前提条件部分下载的模板代码已经有一个名为 .env-example 的示例文件。 将示例文件 .env-example 重命名为 .env,或者创建 .env-example 文件的副本,命名为 .env。 您尚未安装 dotenv,但您将在本快速入门后面运行 bundle install 时安装它。 注:引用本指南步骤的快速入门可能在 .env-example 文件中包含其他环境变量。 有关设置这些附加环境变量的指南,请参考 GitHub 上克隆的项目的快速入门指南。

您需要将这些变量添加到 .env 文件:

  • GITHUB_PRIVATE_KEY:添加您之前生成并保存的私钥。 使用文本编辑器打开 .pem 文件,或使用命令行显示文件的内容:cat path/to/your/private-key.pem。 将文件的全部内容复制为 .env 文件中的 GITHUB_PRIVATE_KEY 值。 注:由于 PEM 文件不止一行,您需要像下面的示例那样在值的两边添加引号。
  • GITHUB_APP_IDENTIFIER:使用您在上一节中注意到的应用程序 ID。
  • GITHUB_WEBHOOK_SECRET:添加您的 web 挂钩密钥。

以下是 .env 文件示例:

PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
...
HkVN9...
...
-----END DSA PRIVATE KEY-----"
GITHUB_APP_IDENTIFIER=12345
GITHUB_WEBHOOK_SECRET=your webhook secret

步骤 5. 审查 GitHub 应用程序模板代码

模板应用程序代码已经包含每个 GitHub 应用程序都需要的一些代码。 本节将引导您浏览 GitHub 应用程序模板中已经存在的代码。 在本节中,您不需要完成任何步骤。 如果您已经熟悉模板代码,则可以跳到“步骤 6. 启动服务器”。

在您喜欢的文本编辑器中打开 template_server.rb 文件。 您会在整个文件中看到为模板代码提供更多上下文信息的注释。 我们建议您仔细阅读这些注释,甚至为您编写的新代码添加自己的注释。

在文件顶部,您将看到 set :port 3000,它设置启动 Web 服务器时使用的端口,以匹配您在“步骤 1. 启动新的 Sme 通道”中将 web 挂钩有效负载重定向到的端口。

您将刚看到的下一段代码是 class GHApp < Sintra::Application 声明。 您将在此类中编写 GitHub 应用程序的所有代码。

模板中现成的类可执行以下操作:

读取环境变量

该类要做的第一件事是读取您在“步骤 4. 准备运行时环境”中设置的三个环境变量,并将它们存储在变量中供以后使用:

# Expects that the private key in PEM format. Converts the newlines
PRIVATE_KEY = OpenSSL::PKey::RSA.new(ENV['GITHUB_PRIVATE_KEY'].gsub('\n', "\n"))

# Your registered app must have a secret set. The secret is used to verify
# that webhooks are sent by GitHub.
WEBHOOK_SECRET = ENV['GITHUB_WEBHOOK_SECRET']

# The GitHub App's identifier (type integer) set when registering an app.
APP_IDENTIFIER = ENV['GITHUB_APP_IDENTIFIER']

开启日志记录

接下来是一个在开发过程中启用日志记录的代码块,这是 Sinatra 中的默认环境。 开发应用程序时,此代码在 DEBUG 级别打开日志记录,以在终端中显示有用的输出:

# Turn on Sinatra's verbose logging during development
configure :development do
  set :logging, Logger::DEBUG
end

定义前置过滤器

Sinatra 使用前置过滤器允许您在路由处理程序之前执行代码。 模板中的 before 块调用四个辅助方法。 模板应用程序在后面的部分定义这些辅助方法。

# Before each request to the `/event_handler` route
before '/event_handler' do
  get_payload_request(request)
  verify_webhook_signature
  authenticate_app
  # Authenticate the app installation in order to run API operations
  authenticate_installation(@payload)
end

定义路由处理程序

模板代码中包含空路由。 此代码处理对 /event_handler 路由的所有 POST 请求。 在本快速入门中,您将不会编写此事件处理程序,但请参阅其他快速入门指南,了解有关如何扩展此模板应用程序的示例。

post '/event_handler' do

end

定义辅助方法

此模板中的辅助方法可以完成大部分繁重的工作。 代码的这一部分中定义了四个辅助方法。

处理 web 挂钩有效负载

第一个方法 get_payload_request 捕获 web 挂钩有效负载并将其转换为 JSON 格式,使访问有效负载的数据变得更容易。

验证 web 挂钩签名

第二个方法 verify_webhook_signature 对 web 挂钩签名进行验证,以确保 GitHub 生成了事件。 要详细了解 verify_webhook_signature 辅助方法中的代码,请参阅“保护 web 挂钩”。 如果 web 挂钩是安全的,则此方法会将所有传入的有效负载记录到您的终端。 记录器代码有助于验证 Web 服务器是否正常运行,但是您以后可以随时删除它。

验证为 GitHub 应用程序

要进行 API 调用,您将使用 Octokit 库。 要对此库进行任何有意义的操作,都需要您(或者更确切地说是您的应用程序)进行身份验证。 GitHub 应用程序有两种身份验证方法:

  • 使用 JSON Web 令牌 (JWT) 验证为 GitHub 应用程序。
  • 使用安装访问令牌验证为 GitHub 应用程序的特定安装设施。

您将在下一节中了解验证为安装设施。

验证为 GitHub 应用程序后可以做两件事:

  • 可以检索有关 GitHub 应用程序的高级别管理信息。
  • 为应用程序安装申请访问令牌。

例如,通过验证为 GitHub 应用程序,您可以检索已安装您的应用程序的帐户(组织帐户和个人帐户)列表。 不过这种身份验证方法不允许您使用 API 做很多事情。 要访问仓库的数据并代表安装设施执行操作,您需要验证为安装设施。 为此,您需要先验证为 GitHub 应用程序才能请求安装设施访问令牌。

在使用 Octokit.rb 库进行 API 调用之前,您需要初始化已验证为 GitHub 应用程序的 Octokit 客户端authenticate_app 辅助方法就可以做到这一点!

# Instantiate an Octokit client authenticated as a GitHub App.
# GitHub App authentication requires that you construct a
# JWT (https://jwt.io/introduction/) signed with the app's private key,
# so GitHub can be sure that it came from the app an not altered by
# a malicious third party.
def authenticate_app
  payload = {
      # The time that this JWT was issued, _i.e._ now.
      iat: Time.now.to_i,

      # JWT expiration time (10 minute maximum)
      exp: Time.now.to_i + (10 * 60),

      # Your GitHub App's identifier number
      iss: APP_IDENTIFIER
  }

  # Cryptographically sign the JWT
  jwt = JWT.encode(payload, PRIVATE_KEY, 'RS256')

  # Create the Octokit client, using the JWT as the auth token.
  @app_client ||= Octokit::Client.new(bearer_token: jwt)
end

上面的代码生成 JSON Web 令牌 (JWT)并使用它(以及应用程序的私钥)来初始化 Octokit 客户端。 GitHub 通过使用应用程序存储的公钥验证令牌来检查请求的身份验证。 要了解有关此代码如何工作的更多信息,请参阅“验证为 GitHub 应用程序”。

验证为安装

安装设施是指已安装该应用程序的任何用户或组织帐户。 即使有人在多个仓库中安装应用程序,也只能算作一个安装设施,因为它们在同一个帐户内。 最后一个辅助方法 authenticate_installation 初始化已验证为安装设施的 Octokit 客户端。 此 Octokit 客户端是您用来进行经验证 API 调用的客户端。

# Instantiate an Octokit client authenticated as an installation of a
# GitHub App to run API operations.
def authenticate_installation(payload)
  installation_id = payload['installation']['id']
  installation_token = @app_client.create_app_installation_access_token(installation_id)[:token]
  @installation_client = Octokit::Client.new(bearer_token: installation_token)
end

create_app_installation_access_token Octokit 方法创建安装令牌。 此方法接受两个参数:

  • 安装 设施(整数):GitHub 应用程序安装设施的 ID
  • 选项(哈希,默认为 {}): 一组可自定义的选项

GitHub 应用程序收到的每个 web 挂钩都包含一个带有 idinstallation 对象。 使用验证为 GitHub 应用程序的客户端,您将此 ID 传递给 create_app_installation_access_token 方法,为每个安装设施生成访问令牌。 由于您没有向该方法传递任何选项,因此这些选项默认为空哈希。 如果回顾一下文档,您可以看到 create_app_installation_access_token 的响应包含两个字段:tokenexpired_at。 模板代码选择响应中的令牌并初始化安装客户端。

使用此方法,您的应用程序每次收到新的 web 挂钩有效负载时,都会为触发事件的安装设施创建一个客户端。 此身份验证过程使您的 GitHub 应用程序能够在任何帐户上的所有安装设施中正常工作。

现在您可以开始进行 API 调用了!

步骤 6. 启动服务器

您的应用程序还没有任何事情,但是现在您可以让它在服务器上运行。

让 Smee 在您终端的当前选项卡中运行。 打开一个新选项卡并 cd 到您克隆了模板应用程序代码的目录中。 此仓库中的 Ruby 代码将启动 Sinatra web 服务器。 此代码有一些依赖项。 可以通过运行以下命令安装它们:

$ gem install bundler

后接:

$ bundle install

安装依赖项后,您可以启动服务器:

$ ruby template_server.rb

您应该会看到如下响应:

> == Sinatra (v2.0.3) has taken the stage on 3000 for development with backup from Puma
> Puma starting in single mode...
> * Version 3.11.2 (ruby 2.4.0-p0), codename: Love Song
> * Min threads: 0, max threads: 16
> * Environment: development
> * Listening on tcp://localhost:3000
> Use Ctrl-C to stop

如果您看到错误,请确保在包含 template_server.rb 的目录中创建了 .env 文件。

服务器运行后,您可以在浏览器中转到 http://localhost:3000 来测试它。 如果应用程序按预期工作,您将看到一个有用的错误页面:

Sinatra 的 404 错误页面

很好! 即使它是一个错误页面,它也是一个 Sinatra 错误页面,这意味着您的应用程序已按预期连接到服务器。 之所以会看到此消息,是因为您还没有给应用程序提供任何要显示的内容。

步骤 7. 在您的帐户上安装应用程序

您可以通过触发要接收的事件来测试服务器是否正在侦听您的应用程序。 您可以测试的一个简单事件是在您的 GitHub 帐户上安装应用程序,这应该会发送 installation 事件。 如果应用程序收到它,您应该会在启动了 template_server.rb 的终端选项卡中看到一些输出。

要安装应用程序,请访问应用程序设置页面,选择您的应用程序,然后在边栏中单击 Install App(安装应用程序)。 在您的用户名旁边,单击 Install(安装)

系统会询问您是在所有仓库还是所选仓库上安装应用程序。 如果您不想在所有仓库上安装该应用程序,那没关系! 您可能需要创建一个沙箱仓库用于测试,并在那里安装您的应用程序。

应用程序安装权限

单击 Install(安装)后,在终端中查看输出。 您应该会看到以下内容:

> D, [2018-06-29T15:45:43.773077 #30488] DEBUG -- : ---- received event integration_installation
> D, [2018-06-29T15:45:43.773141 #30488] DEBUG -- : ----         action created
> 192.30.252.44 - - [29/Jun/2018:15:45:43 -0400] "POST / HTTP/1.1" 200 2 0.0067
> D, [2018-06-29T15:45:43.833016 #30488] DEBUG -- : ---- received event installation
> D, [2018-06-29T15:45:43.833062 #30488] DEBUG -- : ----         action created
> 192.30.252.39 - - [29/Jun/2018:15:45:43 -0400] "POST / HTTP/1.1" 200 2 0.0019

好消息! 这意味着您的应用程序收到了它已安装在您的 GitHub 帐户上的通知。 如果您看到以下图标,则表明您的应用程序正在服务器上按预期运行。 🙌

如果看不到输出,请确保 Smee 能够在另一个终端选项卡中正常运行。 如果需要重新启动 Smee,请注意,您还需要卸载重新安装该应用程序,以便再次向您的应用程序发送 installation 事件并在终端中查看输出。 如果 Smee 不是问题所在,请参阅“疑难解答”部分了解其他想法。

您可能想知道上面的终端输出来自哪里,它是在 template_server.rb应用程序模板代码中写入的内容。

疑难解答

以下是一些常见问题和一些建议的解决方案。 如果您遇到任何其他问题,可以在 GitHub API 开发和支持论坛 中寻求帮助或建议。

  • 问:我尝试安装 Smee 命令行客户端时,出现以下错误:

    > npm: command not found

    :看起来您没有安装 npm。 安装它的最佳方法是在 https://nodejs.org 下载 Node.js 包,然后按照适合您系统的安装说明进行安装。 npm 将随 Node.js 一起安装。

  • 问:我运行服务器时,出现以下错误:

    > server.rb:38:in `initialize': Neither PUB key nor PRIV key: header too long (OpenSSL::PKey::RSAError)

    答:您可能还没有正确设置您的私钥环境变量。 您的 GITHUB_PRIVATE_KEY 变量应如下所示:

    PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
    ...
    HkVN9...
    ...
    -----END RSA PRIVATE KEY-----"
    

    再次检查是否已将正确的公钥复制到 .env 文件中。

  • 问:我运行服务器时,它崩溃并显示以下错误:

    > Octokit::Unauthorized ... 401 - Bad credentials`

    答:您可能被验证为 GitHub 应用程序而不是安装设施。 请确保遵循“验证为安装设施”下的所有步骤,并使用 @installation_client 实例变量(使用安装访问令牌进行身份验证)进行 API 操作,而不是 @app_client 实例变量(使用 JWT 进行身份验证)。 @app_client 只能检索有关应用程序的高级别信息和获取安装访问令牌。 它在 API 中做不了太多其他事情。

  • 问:我的服务器没有侦听事件! Smee 客户端在终端窗口中运行,我正在将应用程序安装到 GitHub 上的仓库中,但是在运行服务器的终端窗口中没有看到任何输出。

    答:您可能没有运行 Smee 客户端,或者您的 GitHub 应用程序设置中没有正确的 Smee 域。 首先检查以确保 Smee 客户端在终端选项卡中运行。 如果这不是问题所在,请访问您的应用程序设置页面并检查“步骤 2. 注册新 GitHub 应用程序”中显示的字段。 确保这些字段中的域与您在“步骤 1”的 smee -u <unique_channel> 命令中使用的域相匹配。 启动新的 Sme 通道”中将 web 挂钩有效负载重定向到的端口。

  • 问:我的调试输出中出现 Octokit::NotFound 404 错误:

    2018-12-06 15:00:56 - Octokit::NotFound - POST https://api.github.com/app/installations/500991/access_tokens: 404 - Not Found // See: /v3/apps/#create-a-new-installation-token:
    

    答:确保 .env 文件中的变量正确。 请确保您没有在任何其他环境变量文件(例如 bash_profile)中设置相同的变量。 您可以通过在应用程序代码中添加 puts 语句并重新运行代码来检查应用程序正在使用的环境变量。 例如,为了确保您有正确的私钥集,可以将 puts PRIVATE_KEY 添加到您的应用程序代码中:

    PRIVATE_KEY = OpenSSL::PKey::RSA.new(ENV['GITHUB_PRIVATE_KEY'].gsub('\n', "\n"))
    puts PRIVATE_KEY
    

结论

完成本指南后,您已了解开发 GitHub 应用程序的基本构建块! 回顾一下:

  • 注册新的 GitHub 应用程序
  • 使用 Sme 接收 web 挂钩有效负载
  • 通过 Sinatra 运行一个简单的 Web 服务器
  • 验证为 GitHub 应用程序
  • 验证为安装设施

后续步骤

现在,您在服务器上运行了 GitHub 应用程序。 它还没有做任何特别的事情,但是您可以在其他快速入门指南中了解一些自定义 GitHub 应用程序模板的方法。

此文档对您有帮助吗?

Privacy policy

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

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

做出贡献

或, 了解如何参与。