GitHub PagesサイトのJekyllビルドエラーについて

Jekyllのビルドエラーについて

サイトの公開元に変更をプッシュした後で、GitHub Pagesがサイトのビルドを試行しない場合があります。

• デプロイキーでプッシュしている。 サイトのリポジトリへのプッシュを自動化する場合は、かわりにマシンユーザーを設定できます。 詳細は GitHub 開発者ドキュメンテーション にある「デプロイキーを管理する」を参照してください。
• 公開元をビルドするようにCIサービスを設定していない。 たとえば、Travis CIはgh-pagesブランチを、セーフリストに追加しない限りビルドしません。 詳細は、Travis CIまたはCIサービスのドキュメンテーションで、「ビルドのカスタマイズ」を参照してください。

Jekyllがサイトのビルドを試行せず、エラーが発生した場合は、ビルドエラーメッセージが表示されます。 Jekyll ビルドエラーメッセージには主に 2 つのタイプがあります。

• 「Page build warning」メッセージは、ビルドは成功したものの、今後問題が生じないようにするために変更を行なう必要がある可能性が存在することを意味します。
• 「Page build failed」メッセージは、ビルドが完了できなかったことを意味します。 Jekyll が失敗の理由を検出できた場合、説明を含むエラーメッセージが表示されます。

ビルドエラーのトラブルシューティングに関する詳しい情報については、「GitHub Pages サイトの Jekyll ビルドエラーのトラブルシューティング」を参照してください。

Jekyll ビルドエラーメッセージを表示する

サイトのテストをローカルで行なうことをお勧めします。それにより、ビルドエラーメッセージをコマンドラインで表示でき、変更を GitHub Enterprise にプッシュする前に、あらゆるビルドエラーに対処できます。 詳しい情報については、「Jekyll を使用して GitHub Pages サイトをローカルでテストする」を参照してください。

GitHub Enterprise の公開元に変更をプッシュする際、GitHub Pages はサイトのビルドを試みます。 ビルドが失敗すると、プライマリメールアドレスにメールが送信されます。 また、ビルドの警告についてのメールも送信されます。

GitHub Enterprise 上のビルドの失敗については、サイトのリポジトリの、[Settings] タブに表示されます。(ただし、ビルドの警告については表示されません。)

各コミット後にエラーメッセージを表示するように、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. サードパーティのテストサービス内で、リポジトリを有効にする必要があるかもしれません。 詳しい情報については、お使いのテストサービスのドキュメンテーションを参照してください。