Referência da ação de origem do CodeCommit

Aciona o pipeline quando uma nova confirmação é feita no repositório e na ramificação configurados do CodeCommit.

Se você usar o console para criar ou editar o pipeline, o CodePipeline criará uma regra do CloudWatch Events do CodeCommit que acionará o pipeline quando ocorrer uma alteração no repositório.

Você já deve ter criado um repositório do CodeCommit para que possa conectar o pipeline por meio de uma ação do CodeCommit.

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: configura a ação de origem do CodeCommit para gerar um arquivo ZIP com uma cópia superficial da sua confirmação.

• Clone completo: configura a ação de origem para gerar uma referência de URL do Git 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.

Tipo de ação

• Categoria: Source

• Proprietário: AWS

• Fornecedor: CodeCommit

• Versão: 1

Parâmetros de configuração

RepositoryName

Obrigatório: Sim

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

BranchName

Obrigatório: Sim

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

PollForSourceChanges

Obrigatório: Não

O PollForSourceChanges determina se o CodePipeline pesquisará o repositório do CodeCommit em busca de alterações na origem. Em vez disso, recomendamos o uso do CloudWatch Events para detectar alterações na origem. Para obter mais informações sobre a configuração do CloudWatch Events, consulte Migrar pipelines de pesquisa (origem do CodeCommit) (CLI) ou Migrar pipelines de sondagem (origem do CodeCommit) (modelo do AWS CloudFormation).

Importante

Se você pretende configurar uma regra do PollForSourceChanges, deverá definir como false para evitar execuções duplicadas do pipeline.

Os valores válidos para esse parâmetro:

• true: se definido, o CodePipeline pesquisará o repositório em busca de alterações na origem.

  nota

  Se você omitir PollForSourceChanges, o CodePipeline assumirá como valor padrão a pesquisa do repositório em busca de alterações na origem. Esse comportamento será o mesmo quando o PollForSourceChanges estiver incluído e definido como true.

• false: se definido, o CodePipeline não pesquisará o repositório em busca de alterações na origem. Use essa configuração caso pretenda configurar uma regra do CloudWatch Events para detectar alterações na origem.

OutputArtifactFormat

Obrigatório: Não

Formato do artefato de saída. Os valores podem 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á adicionar a permissão codecommit:GitPull ao perfil de serviço do CodeBuild, conforme mostrado em Adicione permissões do CodeBuild GitClone para ações de origem do CodeCommit. Você também precisará adicionar as permissões codecommit:GetRepository ao perfil de serviço do CodePipeline, conforme mostrado em Adicionar permissões ao perfil de serviço 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 CodeCommit.

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: O artefato de saída desta ação é 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. Os artefatos gerados a partir do repositório são os artefatos de saída para a ação do CodeCommit. O ID de confirmação do código-fonte é exibido no CodePipeline como a revisão de origem da execução acionada do pipeline.

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 ter mais informações, consulte Referência de variáveis.

CommitId

O ID de confirmação do CodeCommit que acionou a execução do pipeline. Os IDs de confirmação são o SHA completo da confirmação.

CommitMessage

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

RepositoryName

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

BranchName

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

AuthorDate

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

CommitterDate

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

Exemplo de configuração da ação

Exemplo de formato de artefato de saída padrão

YAML

Actions:
  - OutputArtifacts:
      - Name: Artifact_MyWebsiteStack
    InputArtifacts: []
    Name: source
    Configuration:
      RepositoryName: MyWebsite
      BranchName: main
      PollForSourceChanges: 'false'
    RunOrder: 1
    ActionTypeId:
      Version: '1'
      Provider: CodeCommit
      Category: Source
      Owner: AWS
  Name: Source

JSON

{
    "Actions": [
        {
            "OutputArtifacts": [
                {
                    "Name": "Artifact_MyWebsiteStack"
                }
            ],
            "InputArtifacts": [],
            "Name": "source",
            "Configuration": {
                "RepositoryName": "MyWebsite",
                "BranchName": "main",
                "PollForSourceChanges": "false"
            },
            "RunOrder": 1,
            "ActionTypeId": {
                "Version": "1",
                "Provider": "CodeCommit",
                "Category": "Source",
                "Owner": "AWS"
            }
        }
    ],
    "Name": "Source"
},

Exemplo de formato de artefato de saída de clonagem completa

YAML

name: Source
actionTypeId:
  category: Source
  owner: AWS
  provider: CodeCommit
  version: '1'
runOrder: 1
configuration:
  BranchName: main
  OutputArtifactFormat: CODEBUILD_CLONE_REF
  PollForSourceChanges: 'false'
  RepositoryName: MyWebsite
outputArtifacts:
  - name: SourceArtifact
inputArtifacts: []
region: us-west-2
namespace: SourceVariables

JSON

{
    "name": "Source",
    "actionTypeId": {
        "category": "Source",
        "owner": "AWS",
        "provider": "CodeCommit",
        "version": "1"
    },
    "runOrder": 1,
    "configuration": {
        "BranchName": "main",
        "OutputArtifactFormat": "CODEBUILD_CLONE_REF",
        "PollForSourceChanges": "false",
        "RepositoryName": "MyWebsite"
    },
    "outputArtifacts": [
        {
            "name": "SourceArtifact"
        }
    ],
    "inputArtifacts": [],
    "region": "us-west-2",
    "namespace": "SourceVariables"
}

Consulte também

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

• Tutorial: Criar um pipeline simples (repositório do CodeCommit): este tutorial fornece um arquivo de especificação de aplicação de exemplo e um grupo de aplicação e implantação de exemplo do CodeDeploy. Use este tutorial para criar um pipeline com uma origem do CodeCommit implantada em instâncias do Amazon EC2.