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

認証オプションの背景と、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 をインストールします。

ワークフローの例

name: Copilot CLI example
on: [push]

permissions:
  contents: read
  copilot-requests: write

jobs:
  copilot:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 2
      - name: Install Copilot CLI
        run: npm install -g @github/copilot
      - name: Run Copilot
        run: copilot -p "Use git show HEAD to summarize the changes in this commit" -s --allow-tool='shell(git show:*)'
        env:
          GITHUB_TOKEN: ${{ github.token }}

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

• fetch-depth: 2 オプションは現在のコミットとその親を取得し、git show HEAD が現在のコミットによって導入された変更を計算できるようにします。
• --allow-tool='shell(git show:*)' オプションを使用すると、承認を要求せずにCopilot CLIgit showコマンドを実行できます。 非対話型 (-p) の実行では対話型の承認プロンプトを表示できないため、事前に承認されていないアクションは自動的に拒否されます。
• ワークフローがcopilot-requests: write要求を行うには、Copilotアクセス許可が必要です。
• GitHub Actionsによって提供されるGITHUB_TOKENは、認証を自動的に処理します。 追加のシークレットは必要ありません。