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

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á.

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

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

  • Recomendado: A ação do GitHub versão 2 usa autenticação baseada em aplicativo Github apoiada por umCodeStarSourceConnection para ações do Bitbucket, GitHub e GitHub Enterprise ServerRecurso do. Ele instala um aplicativo AWS CodeStar Connections em sua organização GitHub para que você possa gerenciar o acesso no GitHub.

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

nota

Este recurso não está disponível na região Ásia-Pacífico (Hong Kong) ou Europa (Milão). Para usar outras ações de origem disponíveis nessa Região, consulteIntegrações de ações de origem.

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

  • Com conexões, o CodePipeline não requer mais aplicativos OAuth ou tokens de acesso pessoal para acessar seu repositório. Ao criar uma conexão, você instala um aplicativo GitHub que gerencia a autenticação no repositório do GitHub e permite permissões no nível da organização. Você deve autorizar tokens OAuth como um usuário para acessar o repositório. Para obter mais informações sobre o acesso GitHub baseado em OAuth em contraste com o acesso GitHub baseado em aplicativo, consultehttps://docs.github.com/en/developers/apps/differences-between-github-apps-and-oauth-apps.

  • Ao gerenciar ações do GitHub versão 2 na CLI ou no CloudFormation, você não precisa mais armazenar seu token de acesso pessoal como um segredo no Secrets Manager. Você não precisa mais referenciar dinamicamente o segredo armazenado em sua configuração de ação do CodePipeline. Em vez disso, adicione o ARN de conexão à configuração de ação do. Para obter uma configuração de ação de exemplo, consulteCodeStarSourceConnection para ações do Bitbucket, GitHub e GitHub Enterprise Server.

  • Ao criar um recurso de conexão para usar com sua ação GitHub versão 2 no CodePipeline, você pode usar o mesmo recurso de conexão para associar outros serviços suportados, como o AWS CodeGuru Reviewer, ao seu repositório.

  • No Github versão 2, você pode clonar repositórios para acessar metadados do git em ações subsequentes do CodeBuild, enquanto no Github versão 1 você só pode baixar o código-fonte.

  • Um administrador instala o aplicativo para os repositórios da sua organização. Você não precisa mais rastrear tokens OAuth que dependem do indivíduo que criou o token.

Todos os aplicativos instalados 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, consulteExemplo: Uma política com escopo baixo para usar as conexões do AWS CodeStar com um repositório especificado.

Você pode usar as etapas deste tópico para excluir sua 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: Substitua sua ação do GitHub versão 1

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

Para substituir sua ação do GitHub versão 1

  1. Faça login no console CodePipeline.

  2. Escolha seu pipeline e escolhaEdite. SelecioneEdite o estágioem seu estágio de origem. É exibida uma mensagem que recomenda que você atualize sua ação.

  3. DentroProvedor de ação, escolhaGitHub (versão 2).

  4. Execute um destes procedimentos:

    • UnderConexão doSe você ainda não tiver criado uma conexão com seu provedor, escolhaConnect ao GitHub. Continue para a Etapa 2: Crie uma conexão com o GitHub.

    • UnderConexão do, se você já criou uma conexão com seu provedor, escolha a conexão. Continue para a Etapa 3: Salve a ação de origem para sua conexão.

Etapa 2: Criar uma conexão com o GitHub

Depois que você optar por criar a conexão, oConnect ao GitHubé mostrada.

Para criar uma conexão com o GitHub

  1. UnderConfigurações de conexão do GitHub, seu nome de conexão é mostrado emConnection name (Nome da conexão).

    UnderAplicativos GitHub, escolha uma instalação de aplicativo ou escolhaInstalar um novo aplicativoPara criar uma.

    nota

    Você instala um aplicativo para todas as suas conexões com um provedor específico. Se você já instalou o aplicativo GitHub, escolha-o e ignore esta etapa.

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

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

    nota

    Você só instala o aplicativo uma vez para cada conta do GitHub. Se você instalou o aplicativo anteriormente, poderá escolherConfigurepara prosseguir para uma página de modificação para a instalação do aplicativo, ou você pode usar o botão Voltar para retornar ao console.

  4. NoInstalar o AWS CodeStar, escolhaInstall.

  5. NoConnect ao GitHub, o ID de conexão para sua nova instalação é exibido. Selecione Conectar.

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

Conclua suas atualizações noEditar açãopara salvar sua nova ação de origem.

Para salvar sua ação de origem do GitHub

  1. DentroRepositório, informe o nome do seu repositório de terceiros. DentroRamificação, informe a ramificação onde deseja que o pipeline detecte alterações de origem.

    nota

    DentroRepositório, digiteowner-name/repository-namecomo mostrado neste exemplo:

    my-account/my-repository
  2. DentroFormato de artefato de saída, escolha o formato para seus artefatos.

    • Para armazenar artefatos de saída da ação GitHub usando o método padrão, escolhaCodePipeline. A ação acessa os arquivos do repositório 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). Esta opção só pode ser usada por ações downstream do CodeBuild.

      Se você escolher essa opção, será necessário atualizar as permissões para a função de serviço do projeto CodeBuild, conforme mostrado emAdicione permissões do GitClone do CodeBuild para conexões com o Bitbucket, GitHub ou GitHub Enterprise Server. Para obter um tutorial que mostra como usar oClonar completo, consulteTutorial: Usar clone completo com uma fonte de pipeline do GitHub.

  3. DentroArtefatos de saída, você pode manter o nome do artefato de saída para essa ação, como oSourceArtifact. SelecioneConcluídoPara fechar oEditar ação.

  4. SelecioneConcluídopara fechar a página de edição do palco. SelecioneSave (Salvar)para fechar a página de edição do pipeline.