企業のGitHub Actionsのトラブルシューティング

GitHub ActionsでGitHub Enterprise Serverを使用するときに発生する一般的な問題のトラブルシューティング。

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

Site administrators can troubleshoot GitHub Actions issues and modify GitHub Enterprise Server configurations.

この記事で

GitHub Actions の正常性の確認

GitHub Actions コマンドライン ユーティリティを使用して、お使いの GitHub Enterprise Server インスタンスのghe-actions-checkの正常性を確認できます。 詳細については、「コマンド ライン ユーティリティ」および「管理シェル (SSH) にアクセスする」を参照してください。

GitHub Enterprise Server に自己署名証明書を使用する場合のセルフホステッド ランナーの構成

信頼された認証局によって署名された証明書でGitHub Enterprise Server上のTLSを設定することを強くおすすめします。 自己署名証明書でも動作はしますが、セルフホストランナーに追加の設定が必要になり、プロダクションの環境では推奨されません。 詳細については、 AUTOTITLE を参照してください。

ランナーマシンに証明書をインストールする

セルフホステッド ランナーが自己署名証明書を使用して GitHub Enterprise Server に接続するには、接続がセキュリティで強化されるように、ランナー コンピューターに証明書をインストールする必要があります。

証明書をインストールするステップについては、ランナーのオペレーティングシステムのドキュメントを参照してください。

証明書を使用するように Node.JS を設定する

ほとんどのアクションは JavaScript で記述されており、オペレーティングシステムの証明書ストアを使用しない Node.js を使用して実行されます。 セルフホスト ランナー アプリケーションで証明書を使用するには、ランナーのコンピューターで NODE_EXTRA_CA_CERTS 環境変数を設定する必要があります。

この環境変数は、システム環境変数として設定することも、自己ホスト型ランナー アプリケーション ディレクトリ（つまり、ランナー ソフトウェアをダウンロードして解凍したディレクトリ）にある .env というファイルで宣言することもできます。

次に例を示します。

NODE_EXTRA_CA_CERTS=/usr/share/ca-certificates/extra/mycertfile.crt

環境変数は、セルフホストランナーアプリケーションの起動時に読み込まれるため、セルフホストランナーアプリケーションを設定または起動する前に、環境変数を設定する必要があります。 証明書の設定が変更された場合は、セルフホストランナーアプリケーションを再起動する必要があります。

証明書を使用するように Docker コンテナを設定する

ワークフローで Docker コンテナアクションまたはサービスコンテナを使用する場合は、上記の環境変数の設定に加えて、Docker イメージに証明書をインストールする必要がある場合もあります。

GitHub Actions の HTTP プロキシの設定の構成

GitHub に HTTP プロキシ サーバーが構成されている場合

  • HTTP プロキシ除外リストに.localhost、127.0.0.1、::1 を追加 (この順序で) する必要があります。
  • ご利用の外部ストレージの場所がルーティング不可能である場合は、該当する外部ストレージ URL も、除外リストに追加する必要があります。

プロキシ設定の変更の詳細については、「アウトバウンドの Web プロキシ サーバーの設定」を参照してください。

これらの設定が正しく構成されていない場合は、Resource unexpectedly moved to https://IP-ADDRESS構成の設定や変更時にGitHub Actionsなどのエラーが発生する可能性があります。

ランナーが新しいホスト名で GitHub Enterprise Server に接続していない

警告

初期セットアップ後に GitHub Enterprise Server のホスト名を変更しないでください。 ホスト名を変更すると、インスタンスの停止やユーザーのセキュリティ キーの無効化など、予期しない動作が生じます。 インスタンスのホスト名を変更して問題が発生した場合は、GitHub Enterprise サポート または GitHub Premium のサポート に問い合わせてください。

新しいホスト名を使用して環境に GitHub Enterprise Server をデプロイし、古いホスト名がインスタンスに解決されなくなった場合、セルフホステッド ランナーは古いホスト名に接続できず、ジョブは実行されません。

お使いの GitHub Enterprise Server インスタンスの新しいホスト名を使用するには、セルフホステッド ランナーの構成を更新する必要があります。 各セルフホストランナーには、次のいずれかの手順を行う必要があります。

  • セルフホスト ランナー アプリケーション ディレクトリで、.runner と .credentials のファイルを編集して、古いホスト名のすべてのメンションを新しいホスト名に置き換えてから、セルフホスト ランナー アプリケーションを再起動します。
  • UI を使用してランナーを GitHub Enterprise Server から削除し、再度追加します。 詳細については、「セルフホストランナーを削除する」および「自己ホストランナーの追加」を参照してください。

Dependabotが既存のワークフローをトリガーするときのエラーのトラブルシューティング

Dependabotのお使いの GitHub Enterprise Server インスタンス更新プログラムを設定すると、既存のワークフローがDependabot イベントによってトリガーされたときにエラーが発生する場合があります。

既定では、push、pull_request、pull_request_review、または pull_request_review_comment イベントからの GitHub Actions によってトリガーされる Dependabot ワークフロー実行は、リポジトリのフォークから開かれた場合と同様に扱われます。 他のアクターによってトリガーされるワークフローとは異なり、これは読み取り専用の GITHUB_TOKEN を受け取り、通常使用できるシークレットにはアクセスできないことを意味します。 これにより、リポジトリに書き込もうとするワークフローは、 Dependabotによってトリガーされたときに失敗します。

この問題を解決するには、次の 3 つの方法があります。

  1. Dependabotのような式を使用して、ワークフローをif: github.actor != 'dependabot[bot]'によってトリガーされないように、ワークフローを更新できます。 詳しくは、「ワークフロー内とアクション内で式を評価する」をご覧ください。
  2. ワークフローを変更して、このような制限がない pull_request_target を含む 2 段階のプロセスを使用できます。 詳しくは、「GitHub Actions での Dependabot のトラブルシューティング」をご覧ください。
  3. シークレットへのアクセスを Dependabot してトリガーされるワークフローを提供し、 permissions 用語で GITHUB_TOKENの既定のスコープを増やすことができます。 詳細については、以下の 「シークレットへのアクセスとアクセス許可の増加 Dependabot によってトリガーされるワークフローの提供 」を参照してください。

シークレットへのアクセスとアクセス許可の増加 Dependabot によってトリガーされるワークフローを提供する

  1. SSH を使用して管理シェルにログインします。 詳しくは、「管理シェル (SSH) にアクセスする」をご覧ください。

  2. Dependabotでお使いの GitHub Enterprise Server インスタンスによってトリガーされるワークフローの制限を削除するには、次のコマンドを使用します。

    ghe-config app.actions.disable-dependabot-enforcement true

  3. 構成を適用します。

    ghe-config-apply

  4. GitHub Enterprise Server に戻ります。

バンドルされたアクションのトラブルシューティング GitHub Actions

GitHub ActionsにGitHub Enterprise Serverをインストールするときに次のエラーが発生した場合は、公式のバンドルされたアクションとワークフロー テンプレートをインストールすることで問題を解決できます。

A part of the Actions setup had problems and needs an administrator to resolve.

GitHub Enterprise Serverで指定された組織内に公式にバンドルされたアクションとワークフロー テンプレートをインストールするには、次の手順に従います。

  1. 公式のバンドルされたアクションとワークフロー テンプレートを格納する Organization を特定します。 新しい Organization を作成することも、既存のものを再利用することもできます。

  2. SSH を使用して管理シェルにログインします。 詳しくは、「管理シェル (SSH) にアクセスする」をご覧ください。

  3. バンドルされたアクションを格納する場所として Organization を指定するには、ghe-config コマンドを使用して、ORGANIZATION を Organization の名前に置き換えます。

    ghe-config app.actions.actions-org ORGANIZATION

    および

    ghe-config app.actions.github-org ORGANIZATION

  4. バンドルされたアクションを Organization に追加するには、SHA を設定解除します。

    ghe-config --unset 'app.actions.actions-repos-sha1sum'

  5. 構成を適用します。

    ghe-config-apply

これらの手順を完了したら、GitHub Actions での構成を再開できます。