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

ローカルで、または 上で Jekyll を使って Pages サイトをビルドするときにエラーが発生した場合は、エラー メッセージと詳細情報を受け取ります。

この機能を使用できるユーザーについて

Pagesは、パブリック・リポジトリの Freeと組織用の Free、パブリック・リポジトリとプライベート・リポジトリの Pro、 Team、 Enterprise Cloud、 Enterprise Serverで利用できます。 詳細については、「 のプラン」を参照してください。

Pages で、Jekyll ビルドの実行に Actions が使用されるようになりました。 ビルドのソースとしてブランチを使用する際、組み込みの Jekyll ワークフローを使用する場合は、リポジトリで Actions を有効にする必要があります。 Actions が使用できない場合、または無効になっている場合は、ソース ブランチのルートに .nojekyll ファイルを追加すると、Jekyll ビルド プロセスがバイパスされ、コンテンツが直接デプロイされます。 Actions を有効にする方法の詳細については、「リポジトリの Actions の設定を管理する」を参照してください。

この記事の内容

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

ブランチから公開している場合、サイトの公開ソースに変更をプッシュした後で Pages がサイトのビルドを試行しない場合があります。

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

メモ

サイトに対する変更は、その変更を にプッシュしてから公開されるまでに最大 10 分かかることがあります。

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

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

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

デフォルトでは、 Pagesサイトは Pagesサイトが別のCIツールを使うように設定しないかぎり、 Actionsワークフローの実行でビルドされ、デプロイされます。 ビルドの潜在的なエラーを見つけるには、リポジトリのワークフロー実行をレビューすることによって、 Pagesサイトのためのワークフローの実行をチェックできます。 詳しくは、「ワークフロー実行の履歴を表示する」をご覧ください。 エラーが発生した場合にワークフローを再実行する方法の詳細については、「ワークフローとジョブの再実行」を参照してください。

ローカルでのJekyllビルドエラーメッセージの表示

サイトのテストはローカルで行なうことをお勧めします。そうすることで、ビルド エラー メッセージをコマンド ラインに表示し、ビルド エラーがあった場合は解決してから、変更を にプッシュできます。 詳しくは、「Jekyll を使用して Pages サイトをローカルでテストする」をご覧ください。

Pull Request中でのJekyllのビルドエラーメッセージの表示

ブランチから公開している場合、 の公開ソースを更新するために pull request を作成すると、その pull request の [Checks] タブにビルド エラー メッセージが表示されます。 詳しくは、「ステータスチェックについて」をご覧ください。

カスタムの Actions ワークフローを使用して公開している場合、pull request でのビルド エラー メッセージを確認するには、pull_request トリガーに対してそのワークフローが実行されるように構成する必要があります。 これを行う際は、ワークフローが pull_request イベントによってトリガーされた場合に、展開手順をスキップすることをお勧めします。 これにより、pull request からの変更をサイトにデプロイすることなく、ビルド エラーを確認することができます。 詳細については、「ワークフローをトリガーするイベント」および「ワークフローとアクションで式を評価する」を参照してください。

メールでのJekyllのビルドエラーメッセージの表示

ブランチから公開している場合は、 上の公開元に変更をプッシュしたときに、 Pages によって、サイトのビルドが試行されます。 ビルドが失敗すると、プライマリメールアドレスにメールが送信されます。

カスタムの Actions ワークフローを使用して公開している場合、pull request でのビルド エラーに関する Email を受信するには、pull_request トリガーに対してそのワークフローが実行されるように構成する必要があります。 これを行う際は、ワークフローが pull_request イベントによってトリガーされた場合に、展開手順をスキップすることをお勧めします。 これにより、pull request からの変更をサイトにデプロイすることなく、ビルド エラーを確認することができます。 詳細については、「ワークフローをトリガーするイベント」および「ワークフローとアクションで式を評価する」を参照してください。

サードパーティCIサービスでのPull Request中でのJekyllのビルドエラーメッセージの表示

各コミット後にエラー メッセージを表示するように、Travis CI などのサードパーティのサービスを構成できます。

  1. 公開ソースのルートに、以下の内容で Gemfile と呼ばれるファイルをまだ追加していない場合は、追加します。

    source `https://rubygems.org`
gem `-pages`

  2. 選択したテストサービス用にサイトのリポジトリを設定します。 たとえば、Travis CI を使用するには、公開ソースのルートに .travis.yml という名前のファイルを追加し、次の内容を含めます。

    language: ruby
rvm:
  - 2.3
script: "bundle exec jekyll build"

  3. サードパーティのテストサービス内で、リポジトリを有効にする必要があるかもしれません。 詳しい情報については、お使いのテストサービスのドキュメンテーションを参照してください。