CodeStarSourceConnection para Bitbucket, GitHub e GitHub Ações do Enterprise Server 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 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 nas regiões Ásia-Pacífico (Hong Kong) e Europa (Milão) Para fazer referência a outras ações disponíveis, consulteIntegrações de produtos e serviços ao CodePipeline.

As conexões podem associar seuAWSRecursos com os repositórios de terceiros a seguir:

  • Bitbucket Cloud (por meio doBitbucketopção de provedor no 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.

  • GitHub e GitHub Enterprise Cloud (por meio doGitHub (Versão 2)opção de provedor no CodePipeline Console do)

  • GitHub Enterprise Server (por meio doServidor do GitHub Enterpriseopção de provedor no CodePipeline Console do)

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, webhooks são usados para se inscrever no GitHub tipos de eventos e podem ser instalados em uma organização, um repositório ou um GitHub Aplicativo. Sua conexão instala um webhook de repositório em seu GitHub Aplicativo que se inscreve no GitHub eventos de 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 do,CodeStarSourceConnectionO pode produzir um arquivo ZIP com uma cópia superficial do seu commit.

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

    No momento, a referência de URL do Git só pode ser usada por downstream do. CodeBuild Ações 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 resulta em um erro.

O CodePipeline solicita que você adicione oAWSAplicativo de instalação de conector para sua conta de terceiros ao criar uma conexão. Você já deve criar sua conta de provedor de terceiros e repositório do 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 a AWS CodeStar conexões, consulteReferência de permissões de conexõ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 à AWS. CodeStar conexões. Para obter instruções, consulte Adicione permissões à função de serviço 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_REFA opção só pode ser usada por ações downstream do CodeBuild.

Se você escolher essa opção, precisará atualizar as permissões para seu CodeBuild função de serviço do projeto, conforme mostrado emAdicionar CodeBuild Permissões do GitClone para conexões com Bitbucket, GitHub ou GitHub Servidor corporativo. Para um tutorial que mostra como usar oClone completo doopçã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 um novo commit é feito no repositório e ramificação configurados. Se não especificado, o valor padrão serátruee o campo não é exibido por padrão. Os valores válidos para esse parâmetro:

  • true: CodePipeline inicia automaticamente seu pipeline em novos commits.

  • false: CodePipeline não inicia seu 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 CodeBuild Ações downstream do.

      Se você escolher essa opção, precisará atualizar as permissões para seu CodeBuild função de serviço do projeto, conforme mostrado emSolução de problemas do CodePipeline. Para um tutorial que mostra como usar oClone completo doopçã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, consulte Variá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 é definido para o formato ZIP padrão doCODE_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" } ] },

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

Na primeira vez que o console for usado para adicionar uma nova conexão a um repositório de terceiros, você deve autorizar o CodePipeline Acesso aos repositórios do. 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 CloudFormationTemplate, 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 padrão para sondagem. A ação de conexões gerencia a detecção de alterações 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 doAWS CodeStar O recurso Connections fornece parâmetros e exemplos para conexões emAWS CloudFormationModelos do.

  • AWSReferência de API CodeStar Connections API do— OAWS CodeStar Referência de API de conexões doO 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 oBitbucketopção no console ou noCodestarSourceConnectionação na CLI. Consulte Conexões Bitbucket.

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

    • para o GitHub Enterprise Server, use oServidor do GitHub Enterpriseopção de provedor no console ou noCodestarSourceConnectionação na CLI. Consulte Conexões do GitHub Enterprise Server.

  • Para exibir um tutorial de conceitos básicos que cria um pipeline com uma origem Bitbucket e um CodeBuild ação, consulteConceitos básicos sobre conexões.

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