注意
虽然 github-pages gem 仍然支持某些工作流,但现在推荐使用 GitHub Actions 来部署 GitHub Pages 网站并实现其自动化。
关于 Jekyll 构建错误
如果您从分支发布,有时 GitHub Pages 在您将更改推送到站点的发布源之后不会尝试构建您的站点。
- 推送更改的人尚未验证他们的电子邮件地址。 有关详细信息,请参阅 验证电子邮件地址。
- 您使用部署密钥推送。 如果要自动推送到站点的仓库,您可以改为设置计算机用户。 有关详细信息,请参阅“管理部署密钥”。
- 您使用的是未配置为构建发布源的 CI 服务。 例如,Travis CI 不会生成
gh-pages分支,除非将分支添加到安全列表。 有关详细信息,请参阅 Travis CI 上的自定义生成或 CI 服务的文档。
注意
将更改推送到 GitHub网站后,可能需要长达 10 分钟才能发布。
如果 Jekyll 的确尝试构建你的网站并遇到错误,你会收到一条构建错误消息。
有关排查生成错误的详细信息,请参阅“排查 GitHub Pages 网站的 Jekyll 生成错误”。
使用 <a0/a0> 查看 Jekyll 生成错误消息
默认情况下,你的 GitHub Pages 站点会通过 GitHub Actions 工作流运行来构建和部署,除非你已将 GitHub Pages 站点配置为使用其他 CI 工具。 若要查找潜在的构建错误,可以通过查看仓库中的工作流运行记录来检查你的 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` gem `github-pages` -
为您选择的测试服务配置站点仓库。 例如,使用 Travis CI 在发布源的根目录中添加名为 .travis.yml 的文件并包含以下内容:
language: ruby rvm: - 2.3 script: "bundle exec jekyll build" -
您可能需要使用第三方测试服务激活仓库。 更多信息请参阅测试服务的文档。