Atualizar uma ação de origem do GitHub versão 1 para uma ação de origem do GitHub versão 2

No AWS CodePipeline, há duas versões compatíveis da ação de origem do GitHub:

• Recomendado: a ação do GitHub versão 2 usa a autenticação baseada na aplicação do Github apoiada por um recurso CodeStarSourceConnection para Bitbucket Cloud GitHub, GitHub Enterprise Server, GitLab .com e ações GitLab autogerenciadas. Ele instala uma aplicação do AWS CodeStar Connections na organização do GitHub para que você possa gerenciar o acesso no GitHub.

• Não recomendado: a ação do GitHub versão 1 usa tokens do OAuth para se autenticar no GitHub e usa um webhook separado para detectar alterações. Esse não é mais o método recomendado.

nota

As conexões não estão disponíveis nas seguintes regiões: Ásia-Pacífico (Hong Kong), Ásia-Pacífico (Hyderabad), Ásia-Pacífico (Jacarta), Ásia-Pacífico (Melbourne), Asia Pacific (Osaka), África (Cidade do Cabo), Oriente Médio (Bahrein), Oriente Médio (EAU), Europa (Espanha), Europa (Zurique), Israel (Tel Aviv) e AWS GovCloud (Oeste dos EUA). Para fazer referência a outras ações disponíveis, consulte Integrações de produtos e serviços com CodePipeline. Para considerações sobre essa ação na região Europa (Milão), consulte a nota em CodeStarSourceConnection para Bitbucket Cloud GitHub, GitHub Enterprise Server, GitLab .com e ações GitLab autogerenciadas.

Há algumas vantagens importantes em usar a ação do GitHub versão 2 em vez da ação do GitHub versão 1:

• Com conexões, o CodePipeline não precisa mais de aplicações do OAuth nem tokens de acesso pessoal para acessar o repositório. Ao criar uma conexão, você deve instalar uma aplicação do GitHub que gerencie a autenticação no repositório do GitHub e permita permissões em nível de organização. É necessário autorizar tokens do OAuth como usuário para acessar o repositório. Para obter mais informações sobre o acesso ao GitHub baseado no OAuth em contraposição ao acesso ao GitHub baseado em aplicação, consulte https://docs.github.com/en/developers/apps/differences-between-github-apps-and-oauth-apps.

• Ao gerenciar as ações do GitHub versão 2 na CLI ou no CloudFormation, não é mais necessário armazenar o token de acesso pessoal como um segredo no Secrets Manager. Não é mais necessário fazer referência dinamicamente ao segredo armazenado na configuração de ação do CodePipeline. Em vez disso, você adiciona o ARN da conexão à configuração de ação. Para obter um exemplo de configuração de ação, consulte CodeStarSourceConnection para Bitbucket Cloud GitHub, GitHub Enterprise Server, GitLab .com e ações GitLab autogerenciadas.

• Ao criar um recurso de conexão para usar com a ação do GitHub versão 2 no CodePipeline, é possível usar o mesmo recurso de conexão para associar outros serviços compatíveis, como o CodeGuru Reviewer, ao repositório.

• Na versão 2 do Github, é possível clonar repositórios para acessar os metadados do git nas ações subsequentes do CodeBuild, enquanto na versão 1 do Github só é possível baixar a origem.

• Um administrador instala a aplicação nos repositórios da organização. Não é mais necessário rastrear tokens do OAuth que dependam da pessoa que criou o token.

Todas as aplicações instaladas em uma organização têm acesso ao mesmo conjunto de repositórios. Para alterar quem pode acessar cada repositório, modifique a política do IAM para cada conexão. Para ver um exemplo, consulte Exemplo: uma política de restrição de acesso para usar conexões com um repositório especificado.

É possível usar as etapas neste tópico para excluir a ação de origem do GitHub versão 1 e adicionar uma ação de origem do GitHub versão 2 do console do CodePipeline.

Etapa 1: Substituir a ação do GitHub versão 1

Use a página de edição do pipeline para substituir a ação do GitHub versão 1 por uma ação do GitHub versão 2.

Como substituir a ação do GitHub versão 1

1. Faça login no console do CodePipeline.

2. Selecione o pipeline e escolha Editar. Selecione Editar estágio na página de origem. É exibida uma mensagem recomendando que você atualize a ação.

3. Em Provedor de ação, escolha GitHub (versão 2).

4. Execute um destes procedimentos:

   • Em Conexão, se você ainda não criou uma conexão com seu provedor, escolha Conectar ao GitHub. Vá para a Etapa 2: Criar uma conexão com o GitHub.

   • Em Conexão, se você ainda não criou uma conexão com seu provedor, escolha a conexão. Vá para a Etapa 3: Salve a ação de origem para sua conexão.

Etapa 2: Criar uma conexão com o GitHub

Depois de optar por criar a conexão, a página Conectar-se ao GitHub é exibida.

Para criar uma conexão com o GitHub

1. Em Configurações de conexão do GitHub, o nome da conexão aparece em Nome da conexão.

   Em GitHub apps (Aplicações do GitHub), escolha uma instalação de aplicação ou Install a new app (Instalar uma nova aplicação) para criar uma.

   nota

   Você instala uma aplicação para todas as suas conexões com um provedor específico. Se você já instalou a aplicação do GitHub, selecione-a e ignore esta etapa.

2. Se a página de autorização do GitHub for exibida, faça login com as credenciais e escolha a opção de continuar.

3. Na página de instalação da aplicação, uma mensagem mostra que a aplicação do AWS CodeStar está tentando se conectar à conta do GitHub.

   nota

   A aplicação é instalada apenas uma vez para cada conta do GitHub. Se você instalou a aplicação anteriormente, poderá escolher Configure (Configurar) para prosseguir para uma página de modificação para a instalação da aplicação ou usar o botão Back (Voltar) para retornar ao console.

4. Na página Instalar AWS CodeStar, selecione Instalar.

5. Na página Conectar-se ao GitHub, o ID de conexão da nova instalação é exibido. Selecione Conectar.

Etapa 3: Salvar a ação de origem do GitHub

Conclua as atualizações na página Editar ação para salvar a nova ação de origem.

Para salvar a ação de origem do GitHub

1. Em Repositório, insira o nome do repositório de terceiros. Em Ramificação, insira a ramificação onde deseja que o pipeline detecte alterações de origem.

   nota

   No Repositório, digite owner-name/repository-name conforme mostrado neste exemplo:

   my-account/my-repository

2. Em Formato do artefato de saída, escolha o formato dos seus artefatos.

   • Para armazenar artefatos de saída a partir da ação do GitHub usando o método padrão, escolha CodePipeline padrão. A ação acessa os arquivos no repositório do GitHub e armazena os artefatos em um arquivo ZIP no armazenamento de artefatos do pipeline.

   • Para armazenar um arquivo JSON que contém uma referência de URL ao repositório para que as ações downstream possam executar comandos Git diretamente, escolha Full clone (Clone completo). Essa opção só pode ser usada por ações downstream do CodeBuild.

     Se você escolher essa opção, precisará atualizar as permissões do perfil de serviço do projeto CodeBuild, conforme mostrado em Adicione CodeBuild GitClone permissões para conexões com o Bitbucket GitHub, GitHub Enterprise Server ou .com GitLab. Para assistir a um tutorial que mostre como usar a opção Clone completo, consulte Tutorial: Usar o clone completo com uma origem de pipeline do GitHub.

3. Em Artefatos de saída, é necessário manter o nome do artefato de saída para essa ação, como SourceArtifact. Selecione Concluído para fechar a página Editar ação.

4. Selecione Concluído para fechar a página de edição da ação. Selecione Salvar para fechar a página de edição do pipeline.