Variables d'environnement dans les environnements de génération - AWS CodeBuild

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Variables d'environnement dans les environnements de génération

AWS CodeBuild fournit plusieurs variables d'environnement que vous pouvez utiliser dans vos commandes de compilation :

AWS_DEFAULT_REGION

La AWS région dans laquelle le build est en cours d'exécution (par exemple,us-east-1). Cette variable d'environnement est utilisée principalement par l' AWS CLI.

AWS_REGION

La AWS région dans laquelle le build est en cours d'exécution (par exemple,us-east-1). Cette variable d'environnement est principalement utilisée par le AWS SDKs.

CODEBUILD_BATCH_BUILD_IDENTIFIER

L'identifiant de la construction dans une génération par lots. Ceci est spécifié dans les spécifications de construction par lots. Pour de plus amples informations, veuillez consulter Référence de la spécification de construction par Batch.

CODEBUILD_BUILD_ARN

Le nom de ressource Amazon (ARN) de la version (par exemple,arn:aws:codebuild:region-ID:account-ID:build/codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE).

CODEBUILD_ BUILD _IDENTIFIANT

L' CodeBuild ID de la version (par exemple,codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE).

CODEBUILD_BUILD_IMAGE

L'identifiant de l'image de CodeBuild construction (par exemple,aws/codebuild/standard:2.0).

CODEBUILD_BUILD_NUMBER

Numéro de version actuel du projet.

CODEBUILD_BUILD_SUCCEEDING

Si la version actuelle est réussie. Défini sur 0 si la génération échoue, ou sur 1 si la génération aboutit.

CODEBUILD_INITIATOR

Entité à l'origine de la création. Si vous avez CodePipeline démarré la construction, il s'agit du nom du pipeline (par exemple,codepipeline/my-demo-pipeline). Si un utilisateur a lancé le build, il s'agit du nom de l'utilisateur (par exemple,MyUserName). Si le plugin Jenkins pour CodeBuild a démarré la construction, il s'agit de la chaîneCodeBuild-Jenkins-Plugin.

CODEBUILD_ KMS _ KEY _ID

Identifiant de la AWS KMS clé CodeBuild utilisée pour chiffrer l'artefact de sortie de construction (par exemple, arn:aws:kms:region-ID:account-ID:key/key-ID oualias/key-alias).

CODEBUILD_LOG_PATH

Le nom du flux de journal dans CloudWatch les journaux pour la génération.

CODEBUILD_PUBLIC_BUILD_URL

Les résultats URL de cette version sur le site Web public des builds. Cette variable n'est définie que si les versions publiques sont activées dans le projet de construction. Pour de plus amples informations, veuillez consulter Obtenir un projet de construction public URLs.

CODEBUILD_RESOLVED_SOURCE_VERSION

L'identifiant de version du code source d'une version. Le contenu dépend du référentiel de code source :

CodeCommit GitHub, GitHub Enterprise Server et Bitbucket

Cette variable contient l'ID de validation.

CodePipeline

Cette variable contient la révision de la source fournie par CodePipeline.

S'il n' CodePipeline est pas possible de résoudre la révision de la source, par exemple lorsque la source est un compartiment Amazon S3 pour lequel le versionnement n'est pas activé, cette variable d'environnement n'est pas définie.

Amazon S3

Cette variable n'est pas définie.

Le cas échéant, la CODEBUILD_RESOLVED_SOURCE_VERSION variable n'est disponible qu'après la DOWNLOAD_SOURCE phase.

CODEBUILD_SOURCE_REPO_URL

Le URL vers l'artefact d'entrée ou le référentiel de code source. Pour Amazon S3, il est s3:// suivi du nom du compartiment et du chemin d'accès à l'artefact d'entrée. Pour CodeCommit et GitHub, il s'agit du clone du dépôtURL. Si un build provient de CodePipeline, cette variable d'environnement peut être vide.

Pour les sources secondaires, la variable d'environnement du référentiel source secondaire URL estCODEBUILD_SOURCE_REPO_URL_<sourceIdentifier>, où <sourceIdentifier> est l'identifiant de source que vous créez.

CODEBUILD_SOURCE_VERSION

Le format de la valeur dépend du référentiel source.

  • Pour Amazon S3, il s'agit de l'ID de version associé à l'artefact d'entrée.

  • En CodeCommit effet, il s'agit de l'ID de validation ou du nom de branche associé à la version du code source à compiler.

  • Pour GitHub GitHub Enterprise Server et Bitbucket, il s'agit de l'ID de validation, du nom de branche ou du nom de balise associés à la version du code source à créer.

    Note

    Pour une version de serveur GitHub d' GitHub entreprise déclenchée par un événement de pull request webhook, c'est pr/pull-request-number le cas.

Pour les sources secondaires, la variable d'environnement de la version de la source secondaire estCODEBUILD_SOURCE_VERSION_<sourceIdentifier>, où <sourceIdentifier> est l'identifiant de source que vous créez. Pour de plus amples informations, veuillez consulter Exemples de projets avec plusieurs sources d'entrée et plusieurs artefacts de sortie.

CODEBUILD_SRC_DIR

Le chemin du répertoire CodeBuild utilisé pour la construction (par exemple,/tmp/src123456789/src).

Pour les sources secondaires, la variable d'environnement pour le chemin du répertoire source secondaire estCODEBUILD_SRC_DIR_<sourceIdentifier>, où se <sourceIdentifier> trouve l'identifiant de source que vous créez. Pour de plus amples informations, veuillez consulter Exemples de projets avec plusieurs sources d'entrée et plusieurs artefacts de sortie.

CODEBUILD_START_TIME

Heure de début de la construction spécifiée sous forme d'horodatage Unix en millisecondes.

CODEBUILD_ WEBHOOK _ ACTOR _ ACCOUNT _ID

L'ID de compte de l'utilisateur qui a déclenché l'événement webhook.

CODEBUILD_WEBHOOK_BASE_REF

Le nom de référence de base de l'événement webhook qui déclenche la version en cours. Pour une demande d'extraction, c'est ce que l'on appelle la référence de branche.

CODEBUILD_WEBHOOK_EVENT

L'événement webhook qui déclenche la version en cours.

CODEBUILD_WEBHOOK_MERGE_COMMIT

Identifiant du commit de fusion utilisé pour le build. Cette variable est définie lorsqu'une pull request Bitbucket est fusionnée avec la stratégie squash et que la branche pull request est fermée. Dans ce cas, le commit de la pull request d'origine n'existe plus. Cette variable d'environnement contient donc l'identifiant du commit de fusion écrasé.

CODEBUILD_WEBHOOK_PREV_COMMIT

L'ID du dernier commit avant l'événement push du webhook qui déclenche la version en cours.

CODEBUILD_WEBHOOK_HEAD_REF

Le nom de référence principal de l'événement webhook qui déclenche la version en cours. Il peut s'agir d'une référence de branche ou d'une référence de balise.

CODEBUILD_WEBHOOK_TRIGGER

Affiche l'événement webhook qui a déclenché le build. Cette variable est disponible uniquement pour les builds déclenchés par un webhook. La valeur est analysée à partir de la charge utile envoyée CodeBuild à GitHub GitHub Enterprise Server ou Bitbucket. Le format de la valeur dépend de quel type d'événement a déclenché le build.

  • Pour les builds déclenchés par une demande d'extraction, c'est pr/pull-request-number.

  • Pour les builds déclenchés par la création d'une nouvelle branche ou par l'envoi d'un engagement à une branche, c'est branch/branch-name.

  • Pour les builds déclenchés par la transmission d'une balise à un référentiel, c'est tag/tag-name.

HOME

Cette variable d'environnement est toujours définie sur/root.

AWS CodeBuild prend également en charge un ensemble de variables d'environnement pour les versions de coureurs auto-hébergées. Pour en savoir plus sur les coureurs CodeBuild auto-hébergés, consultezTutoriel : Configuration d'un CodeBuild exécuteur d' GitHubactions hébergé.

CODEBUILD_RUNNER_OWNER

Le propriétaire du référentiel qui déclenche la compilation auto-hébergée par Runner.

CODEBUILD_RUNNER_REPO

Le nom du dépôt qui déclenche la compilation auto-hébergée par Runner.

CODEBUILD_RUNNER_REPO_DOMAIN

Le domaine du référentiel qui déclenche la compilation auto-hébergée par le runner. Uniquement les versions GitHub d'entreprise spécifiées.

CODEBUILD_WEBHOOK_LABEL

L'étiquette utilisée pour configurer les remplacements de build et le runner auto-hébergé pendant la construction.

CODEBUILD_ WEBHOOK _ RUN _ID

ID d'exécution du flux de travail associé à la compilation.

CODEBUILD_ WEBHOOK _ JOB _ID

L'ID de tâche de la tâche associée à la version.

CODEBUILD_WEBHOOK_WORKFLOW_NAME

Le nom du flux de travail associé au build s'il existe dans la charge utile de la demande de webhook.

CODEBUILD_RUNNER_WITH_BUILDSPEC

Si une dérogation buildspec est configurée dans les étiquettes de demande d'exécution auto-hébergées, elle est définie sur. true

Vous pouvez également fournir des environnements de génération avec vos propres variables d'environnement. Pour plus d’informations, consultez les rubriques suivantes :

Pour répertorier toutes les variables d'environnement disponibles dans un environnement de génération, vous pouvez exécuter la commande printenv (pour les environnements de génération basés sur Linux) ou "Get-ChildItem Env:" (les environnements de génération basés sur Windows) pendant une génération. À l'exception de celles répertoriées précédemment, les variables d'environnement commençant par CODEBUILD_ sont destinées à un usage CodeBuild interne. Elles ne doivent pas être utilisées dans vos commandes de génération.

Important

Nous déconseillons fortement l'utilisation de variables d'environnement pour stocker des valeurs sensibles, en particulier les clés AWS IDs d'accès. Les variables d'environnement peuvent être affichées en texte brut à l'aide d'outils tels que la CodeBuild console et le AWS CLI.

Nous vous recommandons de stocker les valeurs sensibles dans le magasin de paramètres Amazon EC2 Systems Manager, puis de les récupérer à partir de vos spécifications de construction. Pour stocker des valeurs sensibles, consultez la section Stockage des paramètres de Systems Manager et procédure pas à pas : créer et tester un paramètre de chaîne (console) dans le guide de l'utilisateur d'Amazon EC2 Systems Manager. Pour les récupérer, consultez le mappage parameter-store dans Syntaxe d'un fichier buildspec.