CodeStarSourceConnection para ações gerenciadas do Bitbucket Cloud, do GitHub, do GitHub Enterprise Server, do GitLab.com e do GitLab - AWS CodePipeline
Tipo de açãoParâmetros de configuração Input artifacts (Artefatos de entrada)Artefatos de saídaVariáveis de saídaPermissões do perfil de serviço: ação CodeConnectionsDeclaração de açãoInstalação do aplicativo de instalação e criação de uma conexãoConsulte também

CodeStarSourceConnection para ações gerenciadas do Bitbucket Cloud, do GitHub, do GitHub Enterprise Server, do GitLab.com e do GitLab

Ações de origem para conexões são compatíveis com o Conexões de código da AWS. O CodeConnections permite criar e gerenciar conexões entre recursos da AWS e repositórios de terceiros, como o GitHub. 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 do webhook é enviado pelo provedor de origem.

Você pode configurar ações no pipeline para usar uma configuração do Git que permite iniciar o pipeline com gatilhos. Para definir a configuração de gatilhos do pipeline e aplicar filtros, consulte mais detalhes em Adicionar gatilho com tipos de eventos code push ou pull request.

nota

Este atributo não está disponível na região Ásia-Pacífico (Hong Kong), Ásia-Pacífico (Hyderabad), Ásia-Pacífico (Jacarta), Ásia-Pacífico (Melbourne), Ásia-Pacífico (Osaka), África (Cidade do Cabo), Oriente Médio (Bahrein), Oriente Médio (EAU), Europa (Espanha), Europa (Zurique), Israel (Tel Aviv) ou AWS GovCloud (Oeste dos EUA). Para fazer referência a outras ações disponíveis, consulte Integrações de produtos e serviços com o CodePipeline. Para considerações sobre essa ação na região Europa (Milão), consulte a nota em CodeStarSourceConnection para ações gerenciadas do Bitbucket Cloud, do GitHub, do GitHub Enterprise Server, do GitLab.com e do GitLab.

As conexões podem associar seus recursos da AWS aos seguintes repositórios de terceiros:

  • Bitbucket Cloud (por meio da opção de provedor Bitbucket no console do CodePipeline ou do provedor Bitbucket na CLI)

    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, precisará ter acesso de administrador para criar a conexão.

  • GitHub e GitHub Enterprise Cloud (por meio da opção de provedor GitHub (por meio do aplicativo do GitHub) no console do CodePipeline ou o provedor GitHub na CLI)

    nota

    Se o repositório estiver em uma organização do GitHub, você deverá 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ê precisará ser o proprietário do repositório.

  • GitHub Enterprise Server (por meio da opção de provedor GitHub Enterprise Server no console do CodePipeline ou do provedor GitHub Enterprise Server na CLI)

  • GitLab.com (por meio da opção de provedor GitLab no console do CodePipeline ou do provedor GitLab na CLI)

    nota

    Você pode criar conexões com um repositório em que tenha a função de Proprietário no GitLab e, depois, a conexão pode ser usada com o repositório com recursos como o CodePipeline. Para repositórios em grupos, você não precisa ser o proprietário do grupo.

  • Instalação autogerenciada para o GitLab (Enterprise Edition ou Community Edition) (por meio da opção de provedor autogerenciado do GitLab no console do CodePipeline ou do provedor GitLabSelfManaged na CLI)

nota

Cada conexão oferece suporte a 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 na origem por meio do aplicativo de instalação do provedor de terceiros. Por exemplo, 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 GitHub. Sua conexão instala um webhook de repositório no aplicativo GitHub que se inscreve em eventos do 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: assim como outras ações de origem existentes do CodePipeline, a ação CodeStarSourceConnection pode produzir um arquivo ZIP com uma cópia superficial de sua confirmação.

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

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

O CodePipeline solicita que você adicione o aplicativo de instalação AWS Connector à sua conta de terceiros ao criar uma conexão. Você já deve ter criado sua conta e repositório do provedor de terceiros para que possa se conectar por meio da ação CodeStarSourceConnection.

nota

Para criar ou anexar uma política ao seu perfil com as permissões necessárias para usar o AWS CodeStar Connections, consulte Referência de permissões do Connections. Dependendo de quando o perfil de serviço do CodePipeline foi criado, pode ser necessário atualizar as permissões para oferecer compatibilidade com conexões do AWS CodeStar. Para instruções, consulte Adicionar permissões ao perfil de serviço do CodePipeline.

nota

Para usar conexões na Região da AWS Europa (Milão), é necessário:

  1. Instalar uma aplicação específica da região.

  2. Habilitar a região.

Essa aplicação específica da região é compatível com conexões na região Europa (Milão). Ela é publicada no site do provedor externo e é separada da aplicação existente que permite conexões para outras regiões. Ao instalar essa aplicação, você autoriza provedores externos a compartilhar seus dados somente com o serviço dessa região, mas pode revogar as permissões a qualquer momento ao desinstalá-la.

O serviço não processará nem armazenará seus dados, a menos que você habilite a região. Ao habilitar essa região, você concede ao nosso serviço permissões para processar e armazenar seus dados.

Mesmo que a região não esteja habilitada, provedores externos ainda poderão compartilhar seus dados com nosso serviço se a aplicação específica da região permanecer instalada. Portanto, desinstale a aplicação depois de desabilitar a região. Para obter mais informações, consulte Habilitar uma região.

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 uso correto de maiúsculas e minúsculas para obter o valor FullRepositoryId. Por exemplo, se o nome de usuário for some-user e o nome do repositório for My-Repo, o valor recomendado para FullRepositoryId será 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, precisará atualizar as permissões do perfil de serviço do projeto CodeBuild, conforme mostrado em Adicione permissões do CodeBuild GitClone para conexões com o Bitbucket, o GitHub, o GitHub Enterprise Server ou o GitLab.com. Para assistir a um tutorial que mostre como usar a opção Clone completo, consulte Tutorial: Usar o clone completo com uma origem de pipeline do GitHub.

DetectChanges

Obrigatório: Não

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

  • true: o CodePipeline aciona automaticamente seu pipeline nas novas confirmações.

  • false: o CodePipeline não aciona seu pipeline nas 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 de confirmação do código-fonte é exibido no CodePipeline como a revisão de origem da 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

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

      Se você escolher essa opção, precisará atualizar as permissões do perfil de serviço do projeto CodeBuild, conforme mostrado em Solução de problemas do CodePipeline. Para assistir a um tutorial que mostre como usar a opção Clone completo, consulte Tutorial: Usar o clone completo com uma origem 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 Referência de 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.

Permissões do perfil de serviço: ação CodeConnections

Para CodeConnections, a permissão a seguir é necessária para criar pipelines com uma origem que usa uma conexão, como o Bitbucket Cloud.

{
    "Effect": "Allow",
    "Action": [
        "codeconnections:UseConnection"
    ],
    "Resource": "resource_ARN"
},

Para obter mais informações sobre as permissões do IAM para conexões, consulte Referência de permissões do Connections.

Declaração de ação

No exemplo a seguir, o artefato de saída é definido como o formato ZIP padrão CODE_ZIP para a conexão com o ARN arn: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"
        }
    ]
},

Instalação do aplicativo de instalação e criação de uma conexão

Na primeira vez que você usar o console para adicionar uma nova conexão a um repositório de terceiros, será necessário 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.

Ao usar o AWS CLI ou um modelo do CloudFormation, você deverá fornecer o ARN de uma conexão que já tenha passado pelo handshake de instalação. Caso contrário, o pipeline não é acionado.

nota

Em uma ação de origem CodeStarSourceConnection, você não precisa configurar um webhook ou usar a pesquisa como valor padrão. A ação do Connections gerencia a detecção de alterações na origem para você.

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

  • AWS::CodeStarConnections::Connection: a referência de modelo do CloudFormation para o recurso do AWS CodeStar Connections fornece parâmetros e exemplos de conexões nos modelos do CloudFormation.

  • Referência da API do AWS CodeStar Connections: a Referência da API do AWS CodeStar Connections fornece informações de referência para as ações do Connections disponíveis.

  • Para visualizar as etapas de criação de um pipeline com as ações de origem compatíveis com o Connections, consulte o seguinte:

    • Para o Bitbucket Cloud, use a opção Bitbucket no console ou a ação CodestarSourceConnection na CLI. Consulte Conexões do Bitbucket Cloud.

    • Para o GitHub e o GitHub Enterprise Cloud, use a opção de provedor do GitHub no console ou a ação CodestarSourceConnection na CLI. Consulte Conexões do GitHub.

    • Para o GitHub Enterprise Server, use a opção de provedor GitHub Enterprise Server no console ou a ação CodestarSourceConnection na CLI. Consulte Conexões do servidor do GitHub Enterprise Server.

    • Para Gitlab.com, use a opção GitLab no console ou a ação CodestarSourceConnection com o provedor GitLab na CLI. Consulte Conexões do Gitlab.com.

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

  • Para assistir a um tutorial que mostra como se conectar a um repositório do GitHub e usar a opção Clone completo com uma ação downstream do CodeBuild, consulte Tutorial: Usar o clone completo com uma origem de pipeline do GitHub.