Skip to main content

GitHub Actions で GITHUB_TOKEN を使って Copilot CLI を使用する

Copilot CLI なしで、組み込みの GitHub Actions を使用して、GITHUB_TOKEN ワークフローで personal access token を実行します。

認証オプションの背景と、Copilot CLIでGitHub Actionsを実行するときの課金のしくみについては、GitHub Actions での Copilot CLI の使用について を参照してください。

ポリシーの有効化

組織内のワークフローでCopilot CLIでGITHUB_TOKENを使用するには、ポリシーを有効にする必要があります。 このポリシーは、 Copilot CLI が有効になっている組織では既定で有効になっていますが、組織のポリシー設定でこの設定を確認または変更できます。

  1. 組織のポリシー設定に移動します。 「組織内のGitHub Copilotのポリシーと機能の管理」を参照してください。
  2. [Copilot CLI] で、[ 組織に請求された Copilot CLI の使用を許可する ] が選択されていることを確認します。

推奨されるアプローチ: GitHub エージェント型ワークフロー

ほとんどの自動化のユース ケースでは、ワークフロー ステップで直接GitHubを呼び出すのではなく、copilot Agentic Workflow を使用することをお勧めします。 エージェント ワークフローでは、既定で GITHUB_TOKEN 認証が使用され、自動化された環境に適した追加のガードレールが含まれています。

セットアップ手順については、 Agentic Workflows ドキュメントのGitHubを参照してください。 ワークフローでは、 copilot-requests: write アクセス許可も付与する必要があります。 Agentic Workflows ドキュメントのGitHubを参照してください。

ワークフローで直接 Copilot CLI を使用する

ワークフロー ステップで Copilot CLI を直接呼び出す必要がある場合は、npm を使用して CLI をインストールします。

警告

ワークフローステップで Copilot CLI を直接呼び出すと、ワークフロー環境に幅広くアクセスできます。 このアプローチを使用する前に、ワークフロートリガーとアクセス許可を慎重に確認してください。 フォークからのプル要求によってトリガーされるワークフローは、特に危険にさらされます。

ワークフローの例

name: Copilot CLI example
on: [push]

permissions:
  contents: read
  copilot-requests: write

jobs:
  copilot:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Install Copilot CLI
        run: npm install -g @github/copilot
      - name: Run Copilot
        run: copilot --yolo -p "Summarize the changes in this commit"
        env:
          GITHUB_TOKEN: $

この例に関する重要な詳細:

  • --yolo フラグは、対話型プロンプトを抑制します。これは、GitHub Actionsなどの非対話型環境に必要です。
  • ワークフローがcopilot-requests: write要求を行うには、Copilotアクセス許可が必要です。
  • GITHUB_TOKENによって提供されるGitHub Actionsは認証を自動的に処理します。追加のシークレットは必要ありません。

メモ

Copilot CLI認証を使用するには、最新バージョンのGITHUB_TOKENを使用している必要があります。 copilot updateで更新するか、npm install -g @github/copilotで最新バージョンを再インストールします。