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

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á.

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

AWS CodeBuild fornece várias variáveis de ambiente que você pode usar em seus comandos de construção:

AWS_DEFAULT_REGION

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

AWS_REGION

A AWS região em que 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 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 CodeBuild ID da compilação (por exemplo,codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE).

CODEBUILD_BUILD_IMAGE

O identificador da imagem de CodeBuild construção (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 CodePipeline a compilação foi iniciada, esse é 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 Jenkins CodeBuild iniciou a compilação, essa é a stringCodeBuild-Jenkins-Plugin.

CODEBUILD_ KMS _ KEY _ID

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

CODEBUILD_LOG_PATH

O nome do fluxo de log em CloudWatch Logs para a compilação.

CODEBUILD_PUBLIC_BUILD_URL

Os resultados URL de compilação dessa compilação no site público de compilações. 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 um projeto de construção público URLs.

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 fonte fornecida por CodePipeline.

Se não CodePipeline for possível resolver a revisão da fonte, como quando a origem é um bucket do Amazon S3 que não tem o versionamento ativado, 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 para o 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, esse é o clone URL do repositório. Se uma compilação for originada de CodePipeline, essa variável de ambiente pode estar vazia.

Para fontes secundárias, a variável de ambiente para o repositório de origem secundária URL éCODEBUILD_SOURCE_REPO_URL_<sourceIdentifier>, onde <sourceIdentifier> está o identificador de origem que você cria.

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.

  • Pois CodeCommit, é o ID do commit ou nome da ramificação associado à versão do código-fonte a ser criado.

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

    nota

    Para uma compilação GitHub ou GitHub Enterprise Server que é acionada por um evento de pull request de webhook, é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 CodeBuild usado 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 a partir da carga enviada para CodeBuild by 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.

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 das listadas anteriormente, as variáveis de ambiente que começam com CODEBUILD_ são para uso CodeBuild interno. Elas não devem ser usadas em seus comandos de build.

Importante

Nós desencorajamos fortemente o uso de variáveis de ambiente para armazenar valores confidenciais, especialmente a chave IDs de AWS acesso. As variáveis de ambiente podem ser exibidas em texto simples usando ferramentas como o CodeBuild console e AWS CLI o.

Recomendamos que você armazene valores confidenciais no Amazon EC2 Systems Manager Parameter Store e, em seguida, recupere-os do seu buildspec. Para armazenar valores confidenciais, consulte Armazenamento de parâmetros e instruções passo a passo do Systems Manager: Crie e teste um parâmetro de string (console) no Guia do usuário do Amazon EC2 Systems Manager. Para recuperá-los, consulte o mapeamento parameter-store em Sintaxe de buildspec.