Variables de entorno en los entornos de compilación - AWS CodeBuild

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Variables de entorno en los entornos de compilación

AWS CodeBuild proporciona varias variables de entorno que puedes usar en tus comandos de compilación:

AWS_DEFAULT_REGION

La AWS región en la que se ejecuta la compilación (por ejemplo,us-east-1). Esta variable de entorno se utiliza principalmente en la AWS CLI.

AWS_REGION

La AWS región en la que se ejecuta la compilación (por ejemplo,us-east-1). Esta variable de entorno la utiliza principalmente el AWS SDKs.

CODEBUILD_BATCH_BUILD_IDENTIFIER

Identificador de la compilación en una compilación por lotes. Se indica en la especificación de compilación del lote. Para obtener más información, consulte Referencia de especificaciones de compilación para compilación por lotes.

CODEBUILD_BUILD_ARN

El nombre del recurso de Amazon (ARN) de la compilación (por ejemplo,arn:aws:codebuild:region-ID:account-ID:build/codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE).

CODEBUILD_ BUILD _ID

El CodeBuild ID de la compilación (por ejemplo,codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE).

CODEBUILD_BUILD_IMAGE

El identificador de la imagen de CodeBuild compilación (por ejemplo,aws/codebuild/standard:2.0).

CODEBUILD_BUILD_NUMBER

Número de compilación actual del proyecto.

CODEBUILD_BUILD_SUCCEEDING

Indica si la compilación actual se ha realizado correctamente. Se establece en 0 si la compilación ha producido un error o en 1 si la compilación se ha realizado correctamente.

CODEBUILD_INITIATOR

Entidad que inició la compilación. Si se CodePipeline inició la compilación, este es el nombre de la canalización (por ejemplo,codepipeline/my-demo-pipeline). Si un usuario ha iniciado la compilación, este es el nombre del usuario (por ejemplo, MyUserName). Si el complemento de Jenkins para CodeBuild iniciar la compilación, esta es la cadenaCodeBuild-Jenkins-Plugin.

CODEBUILD_ KMS _ _ID KEY

El identificador de la AWS KMS clave que CodeBuild se utiliza para cifrar el artefacto de salida de la compilación (por ejemplo, arn:aws:kms:region-ID:account-ID:key/key-ID o). alias/key-alias

CODEBUILD_LOG_PATH

El nombre del flujo de registro en CloudWatch los registros de la compilación.

CODEBUILD_PUBLIC_BUILD_URL

El resultado URL de la compilación de esta compilación en el sitio web de compilaciones públicas. Esta variable solo se establece si el proyecto de compilación tiene activadas las compilaciones públicas. Para obtener más información, consulte Obtenga un proyecto de construcción pública URLs.

CODEBUILD_RESOLVED_SOURCE_VERSION

Identificador de versión del código fuente de una compilación. El contenido depende del repositorio de código fuente:

CodeCommit GitHub, GitHub Enterprise Server y Bitbucket

Esta variable contiene el ID de confirmación.

CodePipeline

Esta variable contiene la revisión de origen proporcionada por CodePipeline.

Si CodePipeline no puede resolver la revisión de la fuente, por ejemplo, cuando la fuente es un bucket de Amazon S3 que no tiene habilitado el control de versiones, esta variable de entorno no está configurada.

Amazon S3

Esta variable no está establecida.

Cuando proceda, la variable CODEBUILD_RESOLVED_SOURCE_VERSION solo está disponible después de la fase DOWNLOAD_SOURCE.

CODEBUILD_SOURCE_REPO_URL

Al artefacto de entrada o URL al repositorio de código fuente. En el caso de Amazon S3, este valor es s3:// seguido del nombre del bucket y la ruta del artefacto de entrada. Para CodeCommit y GitHub, este es el clon URL del repositorio. Si se origina una compilación CodePipeline, es posible que esta variable de entorno esté vacía.

En el caso de las fuentes secundarias, la variable de entorno del repositorio de fuentes secundarias URL es CODEBUILD_SOURCE_REPO_URL_<sourceIdentifier> dónde <sourceIdentifier> está el identificador de fuente que se crea.

CODEBUILD_SOURCE_VERSION

El formato del valor depende del repositorio del código fuente.

  • Para Amazon S3, es el ID de versión asociado con el artefacto de entrada.

  • CodeCommitEn efecto, es el identificador de confirmación o el nombre de la rama asociados a la versión del código fuente que se va a crear.

  • GitHubEn el caso de GitHub Enterprise Server y Bitbucket, es el ID de confirmación, el nombre de la rama o el nombre de la etiqueta asociados a la versión del código fuente que se va a crear.

    nota

    En el caso de una GitHub compilación de GitHub Enterprise Server que se desencadena por un evento de solicitud de extracción de webhook, sí lo es. pr/pull-request-number

En el caso de las fuentes secundarias, la variable de entorno de la versión de la fuente secundaria es CODEBUILD_SOURCE_VERSION_<sourceIdentifier>, donde <sourceIdentifier> es el identificador de fuente que se crea. Para obtener más información, consulte Ejemplo de varios orígenes de entrada y varios artefactos de salida.

CODEBUILD_SRC_DIR

La ruta del directorio que se CodeBuild utiliza para la compilación (por ejemplo,/tmp/src123456789/src).

En el caso de las fuentes secundarias, la variable de entorno de la versión de la fuente secundaria es CODEBUILD_SRC_DIR_<sourceIdentifier>, donde <sourceIdentifier> es el identificador de fuente que se crea. Para obtener más información, consulte Ejemplo de varios orígenes de entrada y varios artefactos de salida.

CODEBUILD_START_TIME

Hora de inicio de la compilación especificada como marca temporal de Unix en milisegundos.

CODEBUILD_ WEBHOOK _ ACTOR _ ACCOUNT _ID

ID de la cuenta del usuario que ha desencadenado el evento de webhook.

CODEBUILD_WEBHOOK_BASE_REF

Nombre de referencia de base del evento de webhook que desencadena la compilación actual. En las solicitudes de extracción, se trata de la referencia de ramificación.

CODEBUILD_WEBHOOK_EVENT

Evento de webhook que desencadena la compilación actual.

CODEBUILD_WEBHOOK_MERGE_COMMIT

El identificador de la confirmación de fusión utilizada para la compilación. Esta variable se establece cuando se fusiona una solicitud de extracción de Bitbucket con la estrategia de agrupación y se cierra la rama de la solicitud de extracción. En este caso, la confirmación original de la solicitud de extracción deja de existir, por lo que esta variable de entorno contiene el identificador de la confirmación de fusión anulada.

CODEBUILD_WEBHOOK_PREV_COMMIT

ID de la confirmación más reciente antes del evento push del webhook que desencadena la compilación actual.

CODEBUILD_WEBHOOK_HEAD_REF

Nombre de referencia de encabezado del evento de webhook que desencadena la compilación actual. Puede ser una referencia de ramificación o de etiqueta.

CODEBUILD_WEBHOOK_TRIGGER

Muestra el evento webhook que activó la compilación. Esta variable solo está disponible para compilaciones activadas por un webhook. El valor se analiza a partir de la carga útil enviada CodeBuild por GitHub GitHub Enterprise Server o Bitbucket. El formato del valor depende del tipo de evento que desencadenó la compilación.

  • Para las compilaciones desencadenadas por una solicitud de extracción, es pr/pull-request-number.

  • Para las compilaciones desencadenadas por la creación de una nueva rama o la inserción de una confirmación en una rama, es branch/branch-name.

  • Para compilaciones activadas por el envío de una etiqueta a un repositorio, es tag/tag-name.

HOME

Esta variable de entorno siempre está establecida en /root.

También puede proporcionar entornos de compilación con sus propias variables de entorno. Para obtener más información, consulte los temas siguientes:

Para enumerar todas las variables de entorno disponibles en un entorno de compilación, puede ejecutar el comando printenv (para un entorno de compilación basado en Linux) o "Get-ChildItem Env:" (para entornos de compilación basados en Windows) durante una compilación. A excepción de las enumeradas anteriormente, las variables de entorno que comienzan por CODEBUILD_ son para CodeBuild uso interno. No deben utilizarse en los comandos de compilación.

importante

Se desaconseja encarecidamente el uso de variables de entorno para almacenar valores confidenciales, especialmente las claves IDs de AWS acceso. Las variables de entorno se pueden mostrar en texto plano mediante herramientas como la CodeBuild consola y el AWS CLI.

Le recomendamos que almacene los valores confidenciales en el almacén de parámetros de Amazon EC2 Systems Manager y, a continuación, los recupere de su especificación de compilación. Para almacenar valores confidenciales, consulte Almacén de parámetros de Systems Manager y tutorial: Creación y prueba de un parámetro de cadena (consola) en la Guía del usuario de Amazon EC2 Systems Manager. Para recuperarlos, consulte la asignación de parameter-store en Sintaxis de buildspec.