Configurar um processo de autoatendimento para licenças do GitHub Copilot

Saiba como os usuários podem solicitar uma licença e receber acesso imediatamente.

Neste artigo

Ao habilitar o GitHub Copilot em uma organização ou empresa, você pode configurar um fluxo de trabalho de autoatendimento para permitir que os usuários solicitem licenças. Isso permite que você aloque licenças para pessoas que as desejam e, com isso, as pessoas podem começar a usar o Copilot rapidamente.

O GitHub descobriu que muitas distribuições bem-sucedidas oferecem um modelo de autoatendimento completo em que os desenvolvedores podem solicitar uma licença sem aprovação.

Este artigo descreve duas abordagens que sua empresa pode adotar:

  • O recurso de solicitação de acesso do GitHub para Copilot Business, que não requer nenhuma configuração, mas exige aprovações explícitas de um administrador
  • Sua própria integração com a API do GitHub, que permite criar seu próprio processo com acesso instantâneo

Abordagem 1: usar o recurso de "solicitação de acesso" do GitHub

Se você tem uma assinatura Copilot Business, os membros de uma organização podem solicitar acesso ao GitHub Copilot na página de configurações. Em seguida, um proprietário da organização deve examinar e aprovar cada solicitação.

Veja o processo a seguir, que você deve comunicar aos usuários.

  1. Uma organização ou um proprietário da empresa garante que o Copilot Business esteja habilitado na organização em que você deseja gerenciar o acesso.
  2. Os membros da organização acessam a página de configurações pessoais em https://github.com/settings/copilot e clicam em Solicitar acesso ao administrador.
  3. Um proprietário da organização examina e aprova solicitações na página "Solicitações de membros" na organização. Confira Gerenciar solicitações do Copilot Business em sua organização.

Você deve configurar um processo em que as solicitações são revisadas regularmente, para que os usuários interessados possam obter acesso ao Copilot rapidamente.

Os usuários também podem solicitar acesso de organizações em que o Copilot Business não está habilitado. Nesse caso, os proprietários da organização serão solicitados a pedir que um proprietário da empresa habilite o Copilot para a organização.

Abordagem 2: integrar com a API

Para uma abordagem mais simplificada, você pode configurar um processo de autoatendimento integrando-se à API do GitHub. Os benefícios dessa abordagem são que ela permite que você crie o processo em suas ferramentas existentes e ofereça a opção de permitir que os usuários recebam acesso instantaneamente, sem um processo de aprovação manual.

Para configurar a integração, você usará o ponto de extremidade Adicionar usuários à assinatura do Copilot para uma organização, fornecendo o nome de usuário do usuário que solicitou acesso.

Por exemplo, a chamada à API em um fluxo de trabalho do GitHub Actions pode ser semelhante à seguinte, em que a organização e os nomes de usuário selecionados são fornecidos pelo contexto do gatilho do fluxo de trabalho:

const { Octokit } = require("@octokit/action");
const octokit = new Octokit();
const response = await octokit.request('POST /orgs/{org}/copilot/billing/selected_users', {
  org: context.repo.owner,
  selected_usernames: [context.payload.sender.login],
  headers: {
    'X-GitHub-Api-Version': '2022-11-28'
  }
})

Note

Esse ponto de extremidade só funcionará se você usar organizações no GitHub. Se o GitHub tiver fornecido uma empresa dedicada para gerenciar licenças Copilot Business, você precisará adicionar usuários às equipes corporativas. Para solicitar a documentação da API, entre em contato com seu gerente de conta.

Implementações de exemplo

  • Você pode criar o processo inteiramente dentro do GitHub, fazendo com que os usuários criem Issues para solicitar acesso e, em seguida, usando um fluxo de trabalho do GitHub Actions para chamar a API. Para obter uma demonstração dessa abordagem, consulte o repositório microsoft/GitHubCopilotLicenseAssignment. Observe que este é um exemplo externo que não é coberto pelo Suporte do GitHub.
  • Você pode adicionar um botão "Solicitar acesso" aos perfis dos usuários no site interno da sua empresa, que passará o nome de usuário do GitHub do solicitante para a API. Você pode conceder acesso instantaneamente ou validar o usuário primeiro, como verificar sua associação a uma determinada equipe.

Leitura adicional