CodeStarSourceConnection para ações do Bitbucket, GitHub e GitHub Enterprise Server - 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á.

CodeStarSourceConnection para ações do Bitbucket, GitHub e GitHub Enterprise Server

Aciona um pipeline quando uma nova confirmação é feita em um repositório de código-fonte de terceiros. A ação de origem recupera alterações de código quando um pipeline é executado manualmente ou quando um evento webhook é enviado do provedor de origem.

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.

As conexões podem associar seuAWSCom os seguintes repositórios de terceiros:

  • Bitbucket Cloud (por meio doBitbucketno console do CodePipeline)

    nota

    Você pode criar conexões com um repositório Bitbucket Cloud. Os tipos de provedores Bitbucket instalados, como o Bitbucket Server, não são suportados.

  • GitHub e GitHub Enterprise Cloud (por meio doGitHub (versão 2)no console do CodePipeline)

  • GitHub Enterprise Server (por meio doServidor do GitHub Enterpriseno console do CodePipeline)

nota

Cada conexão suporta todos os repositórios que você tem com esse provedor. Você só precisa criar uma nova conexão para cada tipo de provedor.

As conexões permitem que seu pipeline detecte alterações de origem por meio do aplicativo de instalação do provedor de terceiros. Por exemplo, os webhooks são usados para assinar tipos de eventos do GitHub e podem ser instalados em uma organização, um repositório ou um aplicativo do GitHub. Sua conexão instala um webhook de repositório em seu aplicativo GitHub que se inscreve em eventos de tipo push do GitHub.

Depois que uma alteração de código é detectada, você tem as seguintes opções para passar o código para ações subsequentes:

  • Padrão: Como outras ações de origem CodePipeline existentes,CodeStarSourceConnectionO pode produzir um arquivo ZIP com uma cópia superficial do seu commit.

  • Clonar completo:CodeStarSourceConnectionO também pode ser configurado para gerar uma referência de URL para o repositório para ações subsequentes.

    Atualmente, a referência de URL do Git só pode ser usada por ações downstream CodeBuild ações do CodeBuild para clonar o repositório e os metadados do Git associados. A tentativa de passar uma referência de URL do Git para ações que não são do CodeBuild do resulta em um erro.

O CodePipeline solicita que você adicione oAWSConector para sua conta de terceiros quando você cria uma conexão. Você deve ter criado sua conta e repositório do provedor de terceiros antes de se conectar por meio doCodeStarSourceConnectionAção .

nota

Para criar ou anexar uma política ao usuário ou à função do IAM com as permissões necessárias para usar conexões do AWS CodeStar, consulteReferência de permissões do. Dependendo de quando sua função de serviço CodePipeline foi criada, pode ser necessário atualizar suas permissões para oferecer suporte a outras conexões do AWS CodeStar. Para obter instruções, consulte Adicionar permissões à função de serviço do CodePipeline.

Tipo de ação

  • Categoria: Source

  • Proprietário: AWS

  • Fornecedor: CodeStarSourceConnection

  • Versão: 1

Parâmetros de configuração

ConnectionArn

: obrigatório Sim

O ARN de conexão configurado e autenticado para o provedor de origem.

FullRepositoryId

: obrigatório Sim

O proprietário e o nome do repositório onde as alterações de origem devem ser detectadas.

Exemplo: some-user/my-repo

BranchName

: obrigatório Sim

O nome da ramificação onde as alterações de origem devem ser detectadas.

OutputArtifactFormat

: obrigatório Não

Especifica o formato do artefato de saída. Pode ser CODEBUILD_CLONE_REF ou CODE_ZIP. Se não especificado, o padrão será CODE_ZIP.

Importante

OCODEBUILD_CLONE_REFSó 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 um tutorial que mostra como usar aClonar completo, consulteTutorial: Usar clone completo com uma fonte de pipeline do GitHub.

DetectChanges

: obrigatório Não

Controla a inicialização automática do pipeline quando uma nova confirmação é feita no repositório e na ramificação configurados do. Se não especificado, o valor padrão étruee o campo não é exibido por padrão. Os valores válidos para esse parâmetro:

  • true: CodePipeline inicia automaticamente o pipeline em novas confirmações.

  • false: CodePipeline não inicia o pipeline em novos commits.

Input artifacts (Artefatos de entrada)

  • Número de artefatos: 0

  • Descrição: Os artefatos de entrada não se aplicam a esse tipo de ação.

Artefatos de saída

  • Número de artefatos: 1

  • Descrição: Os artefatos gerados no repositório são os artefatos de saída para a ação do CodeStarSourceConnection. O ID de confirmação do código-fonte é exibido no CodePipeline como a revisão de origem para a execução acionada do pipeline. Você pode configurar o artefato de saída desta ação em:

    • Um arquivo ZIP que contém o conteúdo do repositório e ramificação configurados na confirmação especificada como a revisão de origem para a execução do pipeline.

    • Um arquivo JSON que contém uma referência de URL para o repositório para que as ações downstream possam executar comandos Git diretamente.

      Importante

      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 emSolucionando problemas de. Para um tutorial que mostra como usar aClonar completo, consulteTutorial: Usar clone completo com uma fonte de pipeline do GitHub.

Variáveis de saída

Quando configurada, essa ação produz variáveis que podem ser referenciadas pela configuração de ação de uma ação downstream no pipeline. Esta ação produz variáveis que podem ser visualizadas como variáveis de saída, mesmo que a ação não tenha um namespace. Configure uma ação com um namespace a fim de disponibilizar as variáveis para a configuração de ações downstream.

Para obter mais informações, consulte Variables.

AuthorDate

A data em que a confirmação foi criada, no formato de timestamp.

BranchName

O nome da ramificação do repositório do onde a alteração de origem foi feita.

CommitId

O ID de confirmação do que acionou a execução do pipeline.

CommitMessage

A mensagem da descrição, se houver, associada à confirmação que acionou a execução do pipeline.

ConnectionArn

O ARN de conexão configurado e autenticado para o provedor de origem.

FullRepositoryName

O nome do repositório do onde a confirmação que acionou o pipeline foi feita.

Declaração de ação

No exemplo a seguir, o artefato de saída é definido para o formato ZIP padrão deCODE_ZIPpara a conexão com ARNarn:aws:codestar-connections:region:account-id:connection/connection-id.

YAML
Name: Source Actions: - InputArtifacts: [] ActionTypeId: Version: '1' Owner: AWS Category: Source Provider: CodeStarSourceConnection OutputArtifacts: - Name: SourceArtifact RunOrder: 1 Configuration: ConnectionArn: "arn:aws:codestar-connections:region:account-id:connection/connection-id" FullRepositoryId: "some-user/my-repo" BranchName: "main" OutputArtifactFormat: "CODE_ZIP" Name: ApplicationSource
JSON
{ "Name": "Source", "Actions": [ { "InputArtifacts": [], "ActionTypeId": { "Version": "1", "Owner": "AWS", "Category": "Source", "Provider": "CodeStarSourceConnection" }, "OutputArtifacts": [ { "Name": "SourceArtifact" } ], "RunOrder": 1, "Configuration": { "ConnectionArn": "arn:aws:codestar-connections:region:account-id:connection/connection-id", "FullRepositoryId": "some-user/my-repo", "BranchName": "main", "OutputArtifactFormat": "CODE_ZIP" }, "Name": "ApplicationSource" } ] },

Instalar o aplicativo de instalação e criar uma conexão

Na primeira vez que usar o console para adicionar uma nova conexão a um repositório de terceiros, você deve autorizar o acesso do CodePipeline aos repositórios. Você escolhe ou cria um aplicativo de instalação que o ajuda a se conectar à conta em que o repositório de código de terceiros foi criado.

Quando você usa oAWS CLIou umAWS CloudFormation, você deve fornecer o ARN de conexão de uma conexão que já passou pelo handshake de instalação. Caso contrário, o pipeline não é acionado.

nota

Para umCodeStarSourceConnection, você não precisa configurar um webhook ou padrão para a sondagem. A ação de conexões gerencia sua detecção de alteração de origem para você.

Os recursos relacionados a seguir podem ajudar você à medida que trabalha com esta ação.

  • AWS::CodeStarConnections::Connection— OAWS CloudFormationReferência de modelos doAWSO recurso de Conexões do CodeStar fornece parâmetros e exemplos para conexões noAWS CloudFormationModelos do.

  • AWSReferência de API do CodeStar Connections— OAWSReferência de API do CodeStar ConnectionsO fornece informações de referência para as ações de conexões disponíveis.

  • Para exibir as etapas para criar um pipeline com ações de origem suportadas por conexões, consulte o seguinte:

    • Para Bitbucket, use oBitbucketna consola ou a opçãoCodestarSourceConnectionna CLI. Consulte Conexões do Bitbucket.

    • Para o GitHub e o GitHub Enterprise Cloud, use aGitHubna consola ou naCodestarSourceConnectionna CLI. Consulte Conexões do GitHub.

    • Para o GitHub Enterprise Server, use oServidor do GitHub Enterprisena consola ou naCodestarSourceConnectionna CLI. Consulte Conexões do GitHub Enterprise Server.

  • Para exibir um tutorial de Introdução que cria um pipeline com uma fonte Bitbucket e uma ação CodeBuild, consulteConceitos básicos do.

  • Para um tutorial que mostra como se conectar a um repositório do GitHub e usar oClonar completocom uma ação de CodeBuild downstream, consulteTutorial: Usar clone completo com uma fonte de pipeline do GitHub.