Executar o exemplo de solicitação pull do GitHub e de filtro de webhook para o CodeBuild - AWS CodeBuild

Executar o exemplo de solicitação pull do GitHub e de filtro de webhook para o CodeBuild

O AWS CodeBuild dá suporte a webhooks, quando o repositório de origem é o GitHub. Isso significa que, para um projeto de compilação do CodeBuild que tenha o código-fonte armazenado em um repositório do GitHub, os webhooks podem ser usados para recompilar o código-fonte sempre que uma alteração feita no código é enviada ao repositório. Para ver exemplos do CodeBuild, consulte AWS CodeBuild Samples.

nota

Ao usar webhooks, é possível que um usuário acione uma compilação inesperada. Para atenuar esse risco, consulte Práticas recomendadas para usar webhooks.

Etapa 1: criar um projeto de compilação com o GitHub e habilitar os webhooks

  1. Abra o console do AWS CodeBuild em https://console.aws.amazon.com/codesuite/codebuild/home.

  2. Se uma página de informações do CodeBuild for exibida, selecione Criar projeto de compilação. Caso contrário, no painel de navegação, expanda Compilar, escolha Projetos de compilação e, depois, Criar projeto de compilação.

  3. Selecione Criar projeto de compilação.

  4. Em Configuração de projetos:

    Nome do projeto

    Insira um nome para esse projeto de compilação. Os nomes de projeto de compilação devem ser únicos em cada conta da AWS. Também é possível incluir uma descrição opcional do projeto de compilação para ajudar outros usuários a entender para que esse projeto é usado.

  5. Em Origem:

    Provedor de origem

    Selecione GitHub. Siga as instruções para se conectar (ou se reconectar) ao GitHub e depois escolha Authorize (Autorizar).

    Repositório

    Escolha Repositório em minha conta GitHub.

    Repositório GitHub

    Insira o URL do repositório do GitHub.

  6. Em Eventos de webhook da origem principal, selecione o seguinte.

    nota

    A seção Eventos de webhook da origem principal só estará visível se você escolheu Repositório em minha conta do GitHub na etapa anterior.

    1. Selecione Recompilar toda vez que uma alteração de código for enviada para este repositório ao criar seu projeto.

    2. Em Tipo de evento, escolha um ou mais eventos.

    3. Para filtrar quando um evento aciona uma compilação, em Iniciar uma compilação de acordo com essas condições, adicione um ou mais filtros opcionais.

    4. Para filtrar quando um evento não é acionado, em Não iniciar uma compilação de acordo com essas condições, adicione um ou mais filtros opcionais.

    5. Escolha Adicionar grupo de filtros para adicionar outro grupo de filtros, se necessário.

    Para obter mais informações sobre os tipos e os filtros de eventos de webhook do GitHub, consulte Eventos de webhook do GitHub.

  7. Em Ambiente:

    Imagem do ambiente

    Escolha uma das seguintes opções:

    Para usar uma imagem do Docker gerenciada por AWS CodeBuild:

    Selecione Imagem gerenciada e, depois, faça as seleções em Sistema operacional, Runtime(s), Imagem e Versão da imagem. Faça uma seleção em Tipo de ambiente se estiver disponível.

    Para usar outra imagem do Docker:

    Selecione Imagem personalizada. Em Tipo de ambiente, selecione ARM, Linux, Linux GPU ou Windows. Se você selecionar Outro registro, em URL de registro externo, insira o nome e a tag da imagem do Docker no Docker Hub usando o formato docker repository/docker image name. Se você escolher Amazon ECR, use Repositório do Amazon ECR e Imagem do Amazon ECR para selecionar a imagem do Docker na conta da AWS.

    Para usar uma imagem privada do Docker:

    Selecione Imagem personalizada. Em Tipo de ambiente, selecione ARM, Linux, Linux GPU ou Windows. Em Registro da imagem, selecione Outro registro e insira o ARN das credenciais da imagem privada do Docker. As credenciais devem ser criadas pelo Secrets Manager. Para obter mais informações, consulte O que é o AWS Secrets Manager? no Guia do usuário do AWS Secrets Manager.

    Perfil de serviço

    Escolha uma das seguintes opções:

    • Se você não tiver um perfil de serviço do CodeBuild, selecione Novo perfil de serviço. No campo Nome da função, digite o nome da nova função.

    • Se você tiver um perfil de serviço do CodeBuild, selecione Perfil de serviço existente. Em ARN do perfil, escolha o perfil de serviço.

    nota

    Ao usar o console para criar ou atualizar um projeto de compilação, é possível criar um perfil de serviço do CodeBuild ao mesmo tempo. Por padrão, a função funciona somente com esse projeto de compilação. Se você usar o console para associar esse perfil de serviço a outro projeto de compilação, a função será atualizada para funcionar com os outros projetos de compilação. Um perfil de serviço pode funcionar com até 10 projetos de compilação.

  8. Em Buildspec, siga um destes procedimentos:

    • Escolha Usar um arquivo buildspec para usar o arquivo buildspec.yml no diretório raiz do código-fonte.

    • Selecione Inserir comandos de compilação para usar o console para inserir comandos de compilação.

    Para obter mais informações, consulte Referência de buildspec.

  9. Em Artefatos:

    Tipo

    Escolha uma das seguintes opções:

    • Se você não quiser criar artefatos de saída de compilação, selecione Nenhum artefato.

    • Para armazenar a saída de compilação em um bucket do S3, escolha Amazon S3 e faça o seguinte:

      • Se você quiser usar o nome do projeto para a pasta ou arquivo ZIP de saída da compilação, deixe Nome em branco. Caso contrário, insira o nome. Por padrão, o nome do artefato é o nome do projeto. Se você quiser usar um nome diferente, insira-o na caixa de nome do artefato. Se você quiser gerar um arquivo ZIP, inclua a extensão zip.

      • Para Nome do bucket, selecione o nome do bucket de saída.

      • Se você tiver escolhido Inserir comandos de compilação anteriormente neste procedimento, em Arquivos de saída, insira os locais dos arquivos da compilação que deseja incluir na pasta ou no arquivo ZIP de saída da compilação. Para vários locais, separe-os com uma vírgula (por exemplo, appspec.yml, target/my-app.jar). Para obter mais informações, consulte a descrição de files em Sintaxe de buildspec.

    Configuração adicional

    Expanda Configuração adicional e defina as opções conforme apropriado.

  10. Selecione Criar projeto de compilação. Na página Revisão, escolha Iniciar compilação para executar a compilação.

Etapa 2: verificar se os webhooks estão habilitados

  1. Abra o console do AWS CodeBuild em https://console.aws.amazon.com/codesuite/codebuild/home.

  2. No painel de navegação, selecione Projetos de compilação.

  3. Execute um destes procedimentos:

    • Selecione o link do projeto de compilação com webhooks que você deseja verificar e selecione Detalhes da compilação.

    • Selecione o botão ao lado do projeto de compilação com webhooks que você deseja verificar, selecione Visualizar detalhes e, depois, Detalhes da compilação.

  4. Em Eventos de webhook da origem principal, escolha o link URL do Webhook.

  5. No repositório do GitHub, na página Configurações, em Webhooks, verifique se Solicitações pull e Solicitações push estão selecionadas.

  6. Nas configurações do perfil do GitHub, em Personal settings (Configurações pessoais), Applications (Aplicativos), Authorized OAuth Apps (Aplicativos OAuth autorizados), você verá que seu aplicativo foi autorizado a acessar a região da AWS selecionada.