Autenticação de servidor para servidor

GitHub Actions

Para fluxos de trabalho em um repositório pertencente à organização, conceda ao token interno a permissão para fazer solicitações ao Copilot:

permissions:
  contents: read
  copilot-requests: write

jobs:
  copilot:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - run: your-application
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

A política Permitir o uso do Copilot CLI cobrado da organização da organização deve estar habilitada. Essa abordagem não requer GitHub App nem segredo de autenticação armazenado. Para obter detalhes, consulte Usando Copilot CLI em GitHub Actions com GITHUB_TOKEN.

Outros serviços e sistemas de CI

Para serviços fora GitHub Actions:

1. Crie um aplicativo GitHub com a permissão da organização Copilot Solicitações definida como somente leitura.

2. Instale-o na organização à qual o uso deve ser atribuído e cobrado.

3. Gerando um token de acesso de instalação para um aplicativo GitHub com a permissão Copilot:

   {
     "permissions": {
       "organization_copilot_requests": "read"
     }
   }
   

4. Passe o token resultante ghs_ para o SDK gitHubToken``github_tokenou a opção equivalente. Para um URI de runtime existente, defina-o como COPILOT_GITHUB_TOKEN no processo de runtime.

A organização deve estar habilitada para receber solicitações do Copilot de instalações do GitHub App. Os tokens de instalação expiram após uma hora.

Configurar o tempo de execução

Os exemplos a seguir partem do pressuposto de que o token emitido está em INSTALLATION_TOKEN. Eles o transmitem apenas para o runtime filho e desativam o fallback para credenciais de usuário armazenadas.

import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk";

const token = process.env.INSTALLATION_TOKEN;
if (!token) throw new Error("INSTALLATION_TOKEN is required");

const client = new CopilotClient({
    connection: RuntimeConnection.forStdio(),
    gitHubToken: token,
    useLoggedInUser: false,
});

import os

from copilot import CopilotClient, RuntimeConnection

client = CopilotClient(
    connection=RuntimeConnection.for_stdio(),
    github_token=os.environ["INSTALLATION_TOKEN"],
    use_logged_in_user=False,
)

package main

import (
    "log"
    "os"

    copilot "github.com/github/copilot-sdk/go"
)

func main() {
    token, ok := os.LookupEnv("INSTALLATION_TOKEN")
    if !ok {
        log.Fatal("INSTALLATION_TOKEN is required")
    }
    client := copilot.NewClient(&copilot.ClientOptions{
        Connection:      copilot.StdioConnection{},
        GitHubToken:     token,
        UseLoggedInUser: copilot.Bool(false),
    })
    _ = client
}

use github_copilot_sdk::{ClientOptions, Transport};

fn main() {
    let token = std::env::var("INSTALLATION_TOKEN").expect("INSTALLATION_TOKEN is required");
    let options = ClientOptions::new()
        .with_transport(Transport::Stdio)
        .with_github_token(token)
        .with_use_logged_in_user(false);
    drop(options);
}

using GitHub.Copilot;

var token = Environment.GetEnvironmentVariable("INSTALLATION_TOKEN")
    ?? throw new InvalidOperationException("INSTALLATION_TOKEN is required");

await using var client = new CopilotClient(new CopilotClientOptions
{
    Connection = RuntimeConnection.ForStdio(),
    GitHubToken = token,
    UseLoggedInUser = false,
});

import com.github.copilot.CopilotClient;
import com.github.copilot.rpc.CopilotClientOptions;
import java.util.Objects;

var token = Objects.requireNonNull(
    System.getenv("INSTALLATION_TOKEN"), "INSTALLATION_TOKEN is required");

try (var client = new CopilotClient(new CopilotClientOptions()
        .setGitHubToken(token)
        .setUseLoggedInUser(false))) {
    // Use the client.
}

Para o FFI em processo, use a mesma opção de token; tokens de variável de ambiente no processo de host são ignorados quando useLoggedInUser é falso. Para um URI de runtime existente, defina COPILOT_GITHUB_TOKEN nesse processo de runtime.

Tokens de atualização

Gere um novo token de instalação antes que o token atual expire. Para um processo filho, reinicie o cliente SDK com o novo token. Para um runtime em processo ou existente, reinicie o runtime do host com o novo token.

Billing

O uso é atribuído e cobrado para a organização que possui a instalação do aplicativo GitHub.

Resolução de problemas

Leitura adicional

• Autenticação: outros métodos de autenticação e prioridade
• Gerando um token de acesso de instalação para um aplicativo GitHub: criação de token de aplicativo GitHub