Skip to main content

关于 GitHub Pages 站点的 Jekyll 构建错误

如果在本地或 GitHub Enterprise Server 上构建 GitHub Pages 站点发生 Jekyll 错误,您将收到一条错误消息,其中包含相关详细信息。

GitHub Pages 适用于具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。

关于 Jekyll 构建错误

Sometimes, GitHub Pages 不会尝试生成站点。

  • 您使用部署密钥推送。 如果要自动推送到站点的仓库,您可以改为设置计算机用户。 有关详细信息,请参阅“管理部署密钥”。
  • 您使用的是未配置为构建发布源的 CI 服务。 例如,Travis CI 不会生成 gh-pages 分支,除非将分支添加到安全列表。 有关详细信息,请参阅 Travis CI 上的“自定义生成”或 CI 服务的文档。

注意: 对站点的更改在推送到 GitHub Enterprise Server 后,最长可能需要 10 分钟才会发布。

如果 Jekyll 尝试构建站点但遇到错误,你将收到一条构建错误消息。 Jekyll 构建错误消息有两种主要类型。

  • “Page build warning(页面构建警告)”消息表示构建已成功完成,但您可能需要进行更改以防止将来出现问题。
  • “Page build failed(页面构建失败)”消息表示构建未能完成。 如果 Jekyll 能够检测到失败的原因,您将看到描述性错误消息。

有关排查生成错误的详细信息,请参阅“排查 GitHub Pages 站点的 Jekyll 生成错误”。

查看 GitHub Enterprise Server 上的仓库构建失败

你可以在 GitHub Enterprise Server 上站点存储库的“设置”选项卡中查看生成失败(而不是生成警告)。

在本地查看 Jekyll 构建错误消息

我们建议在本地测试您的站点,这样您可以在命令行上看到构建错误消息,并在更改推送到 GitHub Enterprise Server 之前解决任何构建失败。 有关详细信息,请参阅“使用 Jekyll 在本地测试 GitHub Pages 站点”。

在拉取请求中查看 Jekyll 构建错误消息

When创建拉取请求来更新 GitHub Enterprise Server 上的发布源时,拉取请求的“检查”选项卡上会显示生成错误消息。 有关详细信息,请参阅“关于状态检查”。

通过电子邮件查看 Jekyll 构建错误

When将更改推送到 GitHub Enterprise Server 上的发布源时,GitHub Pages 将尝试生成站点。 如果构建失败,您将在您的主要电子邮件地址收到一封电子邮件。

You will only receive an email if outbound email support is enabled on your GitHub Enterprise Server instance. For more information, contact your site administrator.

使用第三方 CI 服务查看拉取请求中的 Jekyll 构建错误消息

可以将第三方服务(如 Travis CI)配置为在每次提交后显示错误消息。

  1. 如果尚未在发布源的根目录中添加名为 Gemfile 的文件并包含以下内容:

    source `https://rubygems.org`
    gem `github-pages`
    
  2. 为您选择的测试服务配置站点仓库。 例如,使用 Travis CI 在发布源的根目录中添加名为 .travis.yml 的文件并包含以下内容:

    language: ruby
    rvm:
      - 2.3
    script: "bundle exec jekyll build"
    
  3. 您可能需要使用第三方测试服务激活仓库。 更多信息请参阅测试服务的文档。