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

注意

虽然 github-pages gem 在某些工作流中仍受支持，但现在推荐使用 GitHub Actions 来部署和自动化 GitHub Pages 站点。

关于 Jekyll 构建错误

如果你是从分支发布，有时在你将更改推送到站点的发布源后，GitHub Pages 不会尝试构建你的站点。

推送更改的用户尚未验证其电子邮件地址。更多信息，请参阅验证您的电子邮件地址。
你正在使用部署密钥进行推送。如果你想自动化向站点仓库的推送，可以改用机器用户。更多信息，请参阅管理部署密钥。
你使用的 CI 服务未配置为构建你的发布源。例如，Travis CI 除非将 gh-pages 分支加入安全列表，否则不会构建该分支。更多信息，请参阅 Travis CI 上的自定义构建，或你所使用的 CI 服务的文档。

注意

将更改推送到 GitHub 后，站点的更新可能需要最多 10 分钟才能发布。

如果 Jekyll 确实尝试构建你的站点并遇到错误，你将收到一条构建错误信息。

有关排查构建错误的更多信息，请参阅 GitHub Pages 网站的 Jekyll 构建错误排查指南。

通过 GitHub Actions 查看 Jekyll 构建错误信息

默认情况下，除非你已将 GitHub Pages 站点配置为使用其他 CI 工具，否则站点会通过 GitHub Actions 工作流运行进行构建和部署。要查找潜在的构建错误，你可以通过查看仓库的工作流运行来检查 GitHub Pages 站点的工作流运行。更多信息，请参阅查看工作流运行历史。如需了解在出现错误时如何重新运行工作流，请参阅重新运行工作流和作业。

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

我们建议在本地测试站点，这样可以在命令行上看到构建错误信息，并在将更改推送到 GitHub 之前解决任何构建失败的问题。更多信息，请参阅使用 Jekyll 本地测试你的 GitHub Pages 站点。

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

如果你是从分支发布，在 GitHub 上创建用于更新发布源的拉取请求时，你可以在拉取请求的 Checks 选项卡上看到构建错误信息。更多信息，请参阅状态检查概述。

如果你使用自定义的 GitHub Actions 工作流，为了在拉取请求中看到构建错误信息，必须将工作流配置为在 pull_request 触发器上运行。这样做时，我们建议在工作流因 pull_request 事件触发时跳过任何部署步骤。这样即可在不将拉取请求中的更改部署到站点的情况下看到构建错误。更多信息，请参阅触发工作流的事件和在工作流和动作中评估表达式。

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

如果你是从分支发布，当你将更改推送到 GitHub 上的发布源时，GitHub Pages 将尝试构建你的站点。如果构建失败，你会在主电子邮件地址收到一封邮件。

如果你使用自定义的 GitHub Actions 工作流，为了在拉取请求中收到构建错误的邮件通知，必须将工作流配置为在 pull_request 触发器上运行。这样做时，我们建议在工作流因 pull_request 事件触发时跳过任何部署步骤。这样即可在不将拉取请求中的更改部署到站点的情况下看到构建错误。更多信息，请参阅触发工作流的事件和在工作流和动作中评估表达式。

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

你可以配置第三方服务（如 Travis CI），在每次提交后显示错误信息。

如果尚未创建，请在发布源根目录下添加名为 Gemfile 的文件，内容如下：
```
source `https://rubygems.org.cn`
gem `github-pages`
```
为你选择的测试服务配置站点仓库。例如，要使用 Travis CI，请在发布源根目录下添加名为 .travis.yml 的文件，内容如下：
```
language: ruby
rvm:
  - 2.3
script: "bundle exec jekyll build"
```
可能需要在第三方测试服务中激活你的仓库。更多信息，请参阅该测试服务的文档。

谁可以使用此功能？

本文内容