Skip to main content

GITHUB_TOKEN

GITHUB_TOKENとは何か、そのしくみ、GitHub Actionsワークフローの安全な自動化にとって重要な理由について説明します。

GITHUB_TOKEN について

各ワークフロー ジョブの開始時 GitHub 、ワークフローで使用する一意の GITHUB_TOKEN シークレットが自動的に作成されます。 GITHUB_TOKEN はワークフロー ジョブでの認証に使用できます。

GitHub Actionsを有効にすると、GitHubはリポジトリにGitHub Appをインストールします。 GITHUB_TOKEN シークレットは、GitHub Appインストール アクセス トークンです。 インストール アクセス トークンを使用して、リポジトリにインストールされている GitHub App に代わって認証できます。 このトークンの権限は、ワークフローを含むリポジトリに限定されます。 詳細については、「GitHub Actions のワークフロー構文」を参照してください。

各ジョブが開始される前に、 GitHub はジョブのインストール アクセス トークンをフェッチします。 GITHUB_TOKENは、ジョブが終了するか、最大有効期間が経過すると期限切れになります。

トークンの有効な最大有効期間は、ランナーの種類によって異なります。

  • GitHub-hosted runners ジョブの最大実行時間は 6 時間であるため、 GITHUB_TOKEN は最大 6 時間有効です。
  • セルフホステッド ランナー ジョブの最大実行時間は 5 日です。 ただし、GITHUB_TOKEN はインストール access トークンであるため、更新できるのは最大 24 時間です。 ジョブの実行時間が 24 時間を超える場合は、代わりに personal access token またはその他の認証方法を使用します。

トークンは、github.token コンテキストでも使用できます。 詳細については、「コンテキスト リファレンス」を参照してください。

GITHUB_TOKEN がワークフローの実行をトリガーしたとき

リポジトリの GITHUB_TOKEN を使用してタスクを実行する場合、 GITHUB_TOKEN によってトリガーされるイベントは新しいワークフロー実行を作成しません。ただし、次の例外があります。

  • workflow_dispatchrepository_dispatch イベントでは、常にワークフロー実行が作成されます。

その他のすべてのイベントでは、この動作により、再帰的なワークフロー実行が誤って作成されるのを防ぐことができます。 たとえば、ワークフロー実行でリポジトリの GITHUB_TOKEN を使用してコードがプッシュされた場合、push イベントの発生時に実行するように構成されたワークフローがリポジトリに含まれている場合でも、新しいワークフローは実行されません。

GITHUB_TOKEN を使う GitHub Actions ワークフローによってプッシュされたコミットでは、GitHub Pages ビルドがトリガーされません。

次のステップ