GitHub e token de acesso do GitHub Enterprise Server - AWS CodeBuild
Pré-requisitos do token de acesso Conecte-se GitHub com um token de acesso (console) Conecte-se GitHub com um token de acesso (CLI)

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

GitHub e token de acesso do GitHub Enterprise Server

Pré-requisitos do token de acesso

Antes de começar, você deve adicionar os escopos de permissão adequados ao seu token de GitHub acesso.

Pois GitHub, seu token de acesso pessoal deve ter os seguintes escopos.

  • repo: concede controle total de repositórios privados.

  • repo:status: concede acesso de leitura/gravação aos status de confirmação do repositório público e privado.

  • admin:repo_hook: concede controle total de ganchos do repositório. Esse escopo não será obrigatório se o token tiver o escopo repo.

  • admin:org_hook: concede controle total dos ganchos da organização. Esse escopo só é necessário se você estiver usando o recurso de webhook da organização.

Para obter mais informações, consulte Entendendo os escopos dos OAuth aplicativos no GitHub site.

Se você estiver usando tokens de acesso pessoal refinados, dependendo do seu caso de uso, seu token de acesso pessoal pode precisar das seguintes permissões:

  • Conteúdo: Somente leitura: concede acesso a repositórios privados. Essa permissão é necessária se você estiver usando repositórios privados como fonte.

  • Status de confirmação: leitura e gravação: concede permissão para criar status de confirmação. Essa permissão é necessária se seu projeto tiver um webhook configurado ou se você tiver o recurso de status de criação de relatório ativado.

  • Webhooks: Leia e escreva: concede permissão para gerenciar webhooks. Essa permissão é necessária se seu projeto tiver um webhook configurado.

  • Pull requests: somente leitura: concede permissão para acessar pull requests. Essa permissão é necessária se seu webhook tiver um FILE_PATH filtro em eventos de pull request.

  • Administração: Ler e gravar: essa permissão é necessária se você estiver usando o recurso de execução de GitHub ações auto-hospedado com. CodeBuild Para obter mais detalhes, consulte Criar um token de registro para um repositório e. Tutorial: Configurar um CodeBuild executor de GitHub ações hospedado

nota

Se você quiser acessar os repositórios da organização, certifique-se de especificar a organização como proprietária do recurso do token de acesso.

Para obter mais informações, consulte Permissões necessárias para tokens de acesso pessoal refinados no site. GitHub

Conecte-se GitHub com um token de acesso (console)

Para usar o console para conectar seu projeto ao GitHub uso de um token de acesso, faça o seguinte ao criar um projeto. Para ter mais informações, consulte Criar um projeto de compilação (console).

  1. Em Source provider, escolha GitHub.

  2. Para Credencial, faça o seguinte:

    • Escolha Credencial de origem padrão para usar a credencial de origem padrão da sua conta e aplicá-la a todos os projetos.

      1. Se você não estiver conectado GitHub, escolha Gerenciar credencial de origem padrão.

      2. Em Tipo de credencial, escolha Token de acesso pessoal.

      3. Se você escolheu Credencial de origem padrão, em Serviço, escolha qual serviço você gostaria de usar para armazenar seu token e faça o seguinte:

        • Se você optar por usar o Secrets Manager, poderá optar por usar uma conexão secreta existente ou criar um novo segredo e escolher Salvar. Para obter mais informações sobre como criar um novo segredo, consulteCrie e armazene um token em um segredo do Secrets Manager.

        • Se você optar por usar CodeBuild, insira seu token de acesso GitHub pessoal e escolha Salvar.

    • Escolha Credencial de origem personalizada para usar uma credencial de origem personalizada para substituir as configurações padrão da sua conta.

      1. Em Tipo de credencial, escolha Token de acesso pessoal.

      2. Em Conexão, escolha usar uma conexão secreta existente ou criar uma nova.

Conecte-se GitHub com um token de acesso (CLI)

Siga estas etapas para usar o AWS CLI para conectar seu projeto ao GitHub uso de um token de acesso. Para obter informações sobre como usar o AWS CLI with AWS CodeBuild, consulte Referência da linha de comando o.

  1. Execute o comando import-source-credentials: 

    aws codebuild import-source-credentials --generate-cli-skeleton

    JSON- os dados formatados aparecem na saída. Copie os dados para um arquivo (por exemplo,import-source-credentials.json) em um local no computador local ou na instância em que o AWS CLI está instalado. Modifique os dados copiados da maneira a seguir e salve os resultados. 

    {
    "serverType": "server-type",
    "authType": "auth-type",
    "shouldOverwrite": "should-overwrite",
    "token": "token",
    "username": "username"
    }

    Substitua o seguinte:

    • server-type: Valor obrigatório. O provedor de origem usado para essa credencial. Os valores válidos são GITHUBBITBUCKET, GITHUB _ ENTERPRISEGITLAB, e GITLAB _ SELF _MANAGED.

    • auth-type: Valor obrigatório. O tipo de autenticação usado para se conectar a um repositório. Os valores válidos são BASIC PERSONAL _ OAUTHAUTH, ACCESS _ _ TOKENCODECONNECTIONS, e SECRETS _MANAGER. Pois GitHub, somente PERSONAL _ ACCESS _ TOKEN é permitido. BASIC_ só AUTH é permitido com a senha do aplicativo Bitbucket.

    • should-overwrite: Valor opcional. Defina como false para impedir a substituição das credenciais de origem do repositório. Defina como true para substituir as credenciais de origem do repositório. O valor padrão é true.

    • token: Valor obrigatório. Para GitHub nosso GitHub Enterprise Server, esse é o token de acesso pessoal. Para o Bitbucket, esse é o token de acesso pessoal ou a senha do aplicativo. Para o tipo de autenticaçãoCODECONNECTIONS, essa é a conexão. ARN Para o tipo de autenticação SECRETS _MANAGER, esse é o segredo. ARN

    • username: Valor opcional. Esse parâmetro é ignorado para provedores GitHub de origem do GitHub Enterprise Server.

  2. Para conectar sua conta com um token de acesso, alterne para o diretório que contém o arquivo import-source-credentials.json que você salvou na etapa 1 e execute o comando import-source-credentials novamente. 

    aws codebuild import-source-credentials --cli-input-json file://import-source-credentials.json

    JSON- os dados formatados aparecem na saída com um nome de recurso da Amazon ()ARN. 

    {
    "arn": "arn:aws:codebuild:region:account-id:token/server-type"
    }
    nota

    Se você executar o comando import-source-credentials com o mesmo tipo de servidor e tipo de autenticação uma segunda vez, o token de acesso armazenado será atualizado.

    Depois que sua conta estiver conectada a um token de acesso, você poderá usá-lo create-project para criar seu CodeBuild projeto. Para obter mais informações, consulte Criar um projeto de compilação (AWS CLI).

  3. Para visualizar os tokens de acesso conectados, execute o comando list-source-credentials. 

    aws codebuild list-source-credentials

    Um sourceCredentialsInfos objeto JSON formatado aparece na saída: 

    {
        "sourceCredentialsInfos": [
            {
                "authType": "auth-type",
                "serverType": "server-type", 
                "arn": "arn"
            }
        ]
    }

    sourceCredentialsObject contém uma lista de informações de credenciais de origem conectadas:

    • authType é o tipo de autenticação usada pelas credenciais, Isso pode ser OAUTHBASIC_AUTH,PERSONAL_ACCESS_TOKEN,CODECONNECTIONS, ouSECRETS_MANAGER.

    • serverType é o tipo de provedor de origem. Isso pode ser GITHUBGITHUB_ENTERPRISE,BITBUCKET,GITLAB, ouGITLAB_SELF_MANAGED.

    • O arn é o ARN do token.

  4. Para se desconectar de um provedor de origem e remover seus tokens de acesso, execute o delete-source-credentials comando com seuARN. 

    aws codebuild delete-source-credentials --arn arn-of-your-credentials

    JSON- os dados formatados são retornados com uma ARN das credenciais excluídas. 

    {
    "arn": "arn:aws:codebuild:region:account-id:token/server-type"
    }