Variáveis de ambiente em ambientes de compilação - AWS CodeBuild

Variáveis de ambiente em ambientes de compilação

O AWS CodeBuild fornece diferentes variáveis de ambiente para uso nos comandos de build:

AWS_DEFAULT_REGION

A região AWS onde a compilação está sendo executada (por exemplo, us-east-1). Essa variável de ambiente é usada principalmente pelo AWS CLI.

AWS_REGION

A região AWS onde a compilação está sendo executada (por exemplo, us-east-1). Essa variável de ambiente é usada principalmente pelo AWS SDKs.

CODEBUILD_BATCH_BUILD_IDENTIFIER

O identificador da compilação em uma compilação em lote. É determinado na especificação de compilação em lote. Para obter mais informações, consulte Referência de buildspec de compilação em lote.

CODEBUILD_BUILD_ARN

O nome do recurso da Amazon (ARN) da compilação (por exemplo, arn:aws:codebuild:region-ID:account-ID:build/codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE).

CODEBUILD_BUILD_ID

O ID do CodeBuild da compilação (por exemplo, codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE).

CODEBUILD_BUILD_IMAGE

O identificador de imagem de compilação do CodeBuild (por exemplo, aws/codebuild/standard:2.0).

CODEBUILD_BUILD_NUMBER

O número de compilação atual do projeto.

CODEBUILD_BUILD_SUCCEEDING

Se a compilação atual foi bem-sucedida. Defina como 0 caso a compilação falhe, ou 1 caso seja bem-sucedida.

CODEBUILD_INITIATOR

A entidade que iniciou a compilação. Se o CodePipeline iniciou a compilação, é o nome do pipeline (por exemplo, codepipeline/my-demo-pipeline). Se um usuário iniciou a compilação, é o nome do usuário (por exemplo, MyUserName). Se o plug-in do Jenkins para CodeBuild iniciou a compilação, é a string CodeBuild-Jenkins-Plugin.

CODEBUILD_KMS_KEY_ID

O identificador da chave AWS KMS que o CodeBuild usa para criptografar o artefato de saída de compilação (por exemplo, arn:aws:kms:region-ID:account-ID:key/key-ID ou alias/key-alias).

CODEBUILD_LOG_PATH

O nome do fluxo de logs no CloudWatch Logs para a compilação.

CODEBUILD_PUBLIC_BUILD_URL

O URL dos resultados dessa compilação no site de compilações públicas. Essa variável só será definida se o projeto de compilação tiver compilações públicas habilitadas. Para obter mais informações, consulte Obtenha URLs públicos de projetos de compilação.

CODEBUILD_RESOLVED_SOURCE_VERSION

O identificador de versão de um código-fonte de uma compilação. O conteúdo depende do repositório do código-fonte:

CodeCommit, GitHub, GitHub Enterprise Server e Bitbucket

Essa variável contém o ID de confirmação.

CodePipeline

Essa variável contém a revisão da origem fornecida pelo CodePipeline.

Se o CodePipeline não conseguir resolver a revisão da origem, como quando a origem é um bucket do Amazon S3 sem versionamento habilitado, essa variável de ambiente não está definida.

Amazon S3

Essa variável não está definida.

Quando aplicável, a variável CODEBUILD_RESOLVED_SOURCE_VERSION só está disponível após a fase DOWNLOAD_SOURCE.

CODEBUILD_SOURCE_REPO_URL

O URL do artefato de entrada ou repositório de código-fonte. Para o Amazon S3, é s3:// seguido do nome do bucket e o caminho para o artefato de entrada. Para CodeCommit e GitHub, é o URL clone do repositório. Se uma compilação for originada do CodePipeline, essa variável de ambiente poderá estar vazia.

No caso de origens secundárias, a variável de ambiente do URL do repositório de origem secundária é CODEBUILD_SOURCE_REPO_URL_<sourceIdentifier>, em que <sourceIdentifier> é o identificador de origem criado.

CODEBUILD_SOURCE_VERSION

O formato do valor depende do repositório de origem.

  • Para o Amazon S3, é o ID de versão associado ao artefato de entrada.

  • Para o CodeCommit, é o ID de confirmação ou o nome da ramificação associado à versão do código-fonte a ser compilado.

  • Para GitHub, GitHub Enterprise Server e Bitbucket, é o ID de confirmação, nome da ramificação ou nome de tag associado à versão do código-fonte a ser compilado.

    nota

    Para uma compilação de GitHub ou GitHub Enterprise Server que é acionada por um evento de solicitação webhook pull, é pr/pull-request-number.

No caso de origens secundárias, a variável de ambiente da versão de origem secundária é CODEBUILD_SOURCE_VERSION_<sourceIdentifier>, em que <sourceIdentifier> é o identificador de origem criado. Para obter mais informações, consulte Várias fontes de entrada e exemplos de artefatos de saída.

CODEBUILD_SRC_DIR

O caminho do diretório que o CodeBuild usa para a compilação (por exemplo, /tmp/src123456789/src).

No caso de origens secundárias, a variável de ambiente do caminho de diretório de origem secundária é CODEBUILD_SRC_DIR_<sourceIdentifier>, em que <sourceIdentifier> é o identificador de origem criado. Para obter mais informações, consulte Várias fontes de entrada e exemplos de artefatos de saída.

CODEBUILD_START_TIME

A hora de início da compilação especificada como um carimbo de data e hora do Unix em milissegundos.

CODEBUILD_WEBHOOK_ACTOR_ACCOUNT_ID

O ID da conta do usuário que acionou o evento webhook.

CODEBUILD_WEBHOOK_BASE_REF

O nome da referência de base do evento webhook que aciona a compilação atual. Para uma solicitação pull, isso é a referência da ramificação.

CODEBUILD_WEBHOOK_EVENT

O evento webhook que aciona a compilação atual.

CODEBUILD_WEBHOOK_MERGE_COMMIT

O identificador de confirmação de mesclagem usado para a compilação. Essa variável é definida quando uma solicitação pull do Bitbucket é mesclada com a estratégia squash e a ramificação da solicitação pull é fechada. Nesse caso, a confirmação de solicitação pull original não existe mais, portanto, a variável de ambiente contém o identificador da confirmação de mesclagem comprimida.

CODEBUILD_WEBHOOK_PREV_COMMIT

O ID da confirmação mais recente antes do evento de push de webhook que aciona a compilação atual.

CODEBUILD_WEBHOOK_HEAD_REF

O nome da referência head do evento webhook que aciona a compilação atual. Ele pode ser uma ramificação de referência ou uma tag de referência.

CODEBUILD_WEBHOOK_TRIGGER

Mostra o evento webhook que acionou a compilação. Essa variável está disponível apenas para compilações acionadas por um webhook. O valor é analisado na carga útil enviada ao CodeBuild pelo GitHub, GitHub Enterprise Server ou Bitbucket. O formato do valor depende de qual tipo de evento acionou a compilação.

  • Para compilações acionadas por uma solicitação pull, é pr/pull-request-number.

  • Para compilações acionadas por meio da criação de uma nova ramificação ou envio de uma confirmação para uma ramificação, é branch/branch-name.

  • Para compilações acionadas pelo envio de uma tag a um repositório, é tag/tag-name.

HOME

Essa variável de ambiente é sempre configurada como /root.

O AWS CodeBuild também oferece suporte a um conjunto de variáveis de ambiente para compilações de executores auto-hospedados. Para saber mais sobre o executor auto-hospedado do CodeBuild, consulte Tutorial: configurar um executor do GitHub Actions hospedado pelo CodeBuild.

CODEBUILD_RUNNER_OWNER

O proprietário do repositório que aciona a compilação do executor auto-hospedado.

CODEBUILD_RUNNER_REPO

O nome do repositório que aciona a compilação do executor auto-hospedado.

CODEBUILD_RUNNER_REPO_DOMAIN

O domínio do repositório que aciona a compilação do executor auto-hospedado. Somente compilações especificadas do GitHub Enterprise.

CODEBUILD_WEBHOOK_LABEL

O rótulo usado para configurar as substituições de compilação e o executor auto-hospedado durante a compilação.

CODEBUILD_WEBHOOK_RUN_ID

O ID de execução do fluxo de trabalho associado à compilação.

CODEBUILD_WEBHOOK_JOB_ID

O ID do trabalho associado à compilação.

CODEBUILD_WEBHOOK_WORKFLOW_NAME

O nome do fluxo de trabalho associado à compilação, se existir na carga útil da solicitação do webhook.

CODEBUILD_RUNNER_WITH_BUILDSPEC

Se uma substituição de buildspec estiver configurada nos rótulos de solicitação do executor auto-hospedado, isso será definido como true.

Você também pode fornecer ambientes de build com suas próprias variáveis de ambiente. Para obter mais informações, consulte os tópicos a seguir.

Para exibir todas as variáveis de ambiente disponíveis em um ambiente de compilação, você pode executar o comando printenv (em ambientes de compilação baseados no Linux) ou o comando "Get-ChildItem Env:" (em ambientes de compilação baseados no Windows) durante uma compilação. Com exceção daquelas listadas anteriormente, as variáveis de ambiente iniciadas com CODEBUILD_ são para uso interno do CodeBuild. Elas não devem ser usadas em seus comandos de build.

Importante

Não recomendamos o uso de variáveis de ambiente para armazenar valores confidenciais, em especial, IDs de chave de acesso da AWS. As variáveis de ambiente podem ser exibidas em texto sem formatação com ferramentas, como o console do CodeBuild e a AWS CLI.

Recomendamos armazenar os valores confidenciais no Amazon EC2 Systems Manager Parameter Store e recuperá-los do buildspec. Para armazenar valores confidenciais, consulte Systems Manager Parameter Store e Walkthrough: Create and test a String parameter (console) no Guia do usuário do Amazon EC2 Systems Manager. Para recuperá-los, consulte o mapeamento parameter-store em Sintaxe de buildspec.