CodeStarSourceConnection para Bitbucket, GitHub, e GitHub Ações do 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 Bitbucket, GitHub, e GitHub Ações do 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 no código quando um pipeline é executado manualmente ou quando um evento de webhook é enviado pelo provedor de origem.

nota

Esse recurso não está disponível nas regiões Ásia-Pacífico (Hong Kong) e Europa (Milão) Para referenciar outras ações disponíveis, consulteIntegrações de produtos e serviços ao CodePipeline.

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

  • Bitbucket Cloud (por meio doBitbucketopção de provedor na CodePipeline Console do)

    nota

    Você pode criar conexões para um repositório do Bitbucket Cloud. Não há suporte a tipos de provedores instalados do Bitbucket, como o Bitbucket Server.

  • nota

    Se você estiver usando um espaço de trabalho do Bitbucket, deverá ter acesso de administrador para criar a conexão.

  • GitHub e GitHub Nuvem corporativa (por meio doGitHub (Versão 2)opção de provedor na CodePipeline Console do)

    nota

    Se o seu repositório estiver em um GitHub organização, você deve ser o proprietário da organização para criar a conexão. Se você estiver usando um repositório que não esteja em uma organização, você deve ser o proprietário do repositório.

  • GitHub Servidor corporativo (por meio doGitHub Enterprise Serveropção de provedor na CodePipeline Console do)

nota

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

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

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 outros existentes CodePipeline ações de origem,CodeStarSourceConnectionpode gerar um arquivo ZIP com uma cópia superficial do seu commit.

  • Clongem completo:CodeStarSourceConnectiontambé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 downstream CodeBuild ações para clonar o repositório e os metadados Git associados. Tentativa de passar uma referência de URL do Git para não-CodeBuild ações resultam em um erro.

CodePipeline solicita que você adicione oAWSConecte o aplicativo de instalação da sua conta de terceiros ao criar uma conexão. Você já deve ter criado sua conta de provedor de terceiros e o repositório antes de conectar-se 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 o AWS CodeStar conexões, consulteReferência de permissões. Dependendo de quando seu CodePipeline A função de serviço foi criada, pode ser necessário atualizar suas permissões para oferecer suporte ao AWS CodeStar conexões. 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

Importante

Você deve manter o caso correto para oFullRepositoryIdvalue. Por exemplo, se seu nome de usuário forsome-usere o nome do repositório éMy-Repo, o valor recomendado deFullRepositoryIdé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

A opção CODEBUILD_CLONE_REF só pode ser usada por ações downstream do CodeBuild.

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

DetectChanges

Obrigatório: Não

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

  • true: CodePipeline inicia automaticamente seu funil com novas confirmações.

  • false: CodePipeline não inicia seu pipeline com novas confirmações.

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 do commit do código-fonte é exibido em CodePipeline como a revisão da fonte para a execução do pipeline acionado. 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 CodeBuild ações a jusante.

      Se você escolher essa opção, será necessário atualizar as permissões do CodeBuild função de serviço de projeto, conforme mostrado emSolução de problemas CodePipeline. Para obter um tutorial que mostra como usar oClongem completoopção, 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, consulteVariáveis

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 está definido para o formato ZIP padrão deCODE_ZIPpara a conexão com o 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" } ] },

Instalando o aplicativo de instalação e criando uma conexão

Na primeira vez que você usar o console para adicionar uma nova conexão a um repositório de terceiros, você deve autorizar CodePipeline acesso aos seus 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 CloudFormationmodelo, 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 umCodeStarSourceConnectionação de origem, você não precisa configurar um webhook ou configurar como padrão a pesquisa. A ação de conexões gerencia sua detecção de alterações na fonte 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 para oAWS CodeStar O recurso Conexões fornece parâmetros e exemplos de conexões emAWS CloudFormationModelos.

  • AWS CodeStarReferência da API de conexões— OAWS CodeStar Referência da API de conexõesfornece informações de referência para as ações de conexões disponíveis.

  • Para ver as etapas de criação de um pipeline com ações de origem suportadas por conexões, consulte o seguinte:

    • Para o Bitbucket, use oBitbucketopção no console ou noCodestarSourceConnectionação na CLI. Consulte Conexões do Bitbucket.

    • Para GitHub e GitHub Enterprise Cloud, use oGitHubopção de provedor no console ou noCodestarSourceConnectionação na CLI. Consulte GitHub conexões.

    • Para GitHub Enterprise Server, use oGitHub Enterprise Serveropção de provedor no console ou noCodestarSourceConnectionação na CLI. Consulte Conexões do GitHub Enterprise Server.

  • Para ver um tutorial de introdução que cria um pipeline com uma fonte do Bitbucket e um CodeBuild ação, vejaConceitos básicos sobre conexões.

  • Para obter um tutorial que mostra como conectar-se a um GitHub repositório e use oClongem completoopção com um downstream CodeBuild ação, vejaTutorial: Usar clone completo com uma fonte de pipeline do GitHub.