Umgebungsvariablen in Build-Umgebungen - AWS CodeBuild

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Umgebungsvariablen in Build-Umgebungen

AWS CodeBuild bietet mehrere Umgebungsvariablen, die Sie in Ihren Build-Befehlen verwenden können:

AWS_DEFAULT_REGION

DieAWS Region, in der der Build ausgeführt wird (z. B.us-east-1). Diese Umgebungsvariable wird hauptsächlich bei der AWS CLI verwendet.

AWS_REGION

DieAWS Region, in der der Build ausgeführt wird (z. B.us-east-1). Diese Umgebungsvariable wird hauptsächlich von den AWS SDKs verwendet.

CODEBUILD_BATCH_BUILD_IDENTIFIER

Die ID des Builds in einem Batch-Build. Dies ist in der Batch-Buildspec angegeben. Weitere Informationen finden Sie unter Batch-Build-Buildspec Referenz.

CODEBUILD_BUILD_ARN

Der Amazon-Ressourcenname (ARN ARN ARN N N N ARN N N ARN N ARN N ARN N ARN N ARNarn:aws:codebuild:region-ID:account-ID:build/codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE

CODEBUILD_BUILD_ID

DieCodeBuild ID des Builds (zum Beispielcodebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE).

CODEBUILD_BUILD_IMAGE

DieCodeBuild Build-Image-ID (z. B.aws/codebuild/standard:2.0).

CODEBUILD_BUILD_NUMBER

Build-Nummer des Projekt.

CODEBUILD_BUILD_SUCCESS

Ob der aktuelle Build erfolgreich ist. Legen Sie den Wert auf 0 fest, wenn der Build fehlschlägt, und auf 1, wenn er erfolgreich ausgeführt wird.

CODEBUILD-INITIATOR

Die Entität, die den Build gestartet hat. Wenn CodePipeline den Build gestartet hat, ist dies der Name der Pipeline (beispielsweise codepipeline/my-demo-pipeline). Wenn ein Benutzer den Build gestartet hat, ist dies der Name des Benutzers (z. B.MyUserName). Wenn das Jenkins-Plugin für CodeBuild den Build gestartet hat, lautet die Zeichenfolge CodeBuild-Jenkins-Plugin.

CODEBUILD_KMS_KEY_ID

Die Kennung desAWS KMS Schlüssels, der zum Verschlüsseln des Build-Ausgabeartefakts verwendetCodeBuild wird (z. B.arn:aws:kms:region-ID:account-ID:key/key-ID oderalias/key-alias).

CODEBUILD_LOG-PFAD

Der Name des Log-Streams inCloudWatch Logs für den Build.

CODEBUILD_PUBLIC_BUILD_URL

Die URL der Build-Ergebnisse für diesen Build auf der öffentlichen Build-Website. Diese Variable wird nur gesetzt, wenn für das Build-Projekt öffentliche Builds aktiviert sind. Weitere Informationen finden Sie unter Öffentliche Build-Projekte inAWS CodeBuild.

CODEBUILD_RESOLVED_QUELLVERSION

Die Versionskennung des Quellcodes eines Builds. Der Inhalt hängt vom Quellcode-Repository ab:

CodeCommitGitHub,GitHub Enterprise Server und Bitbucket

Diese Variable enthält die Commit-ID.

CodePipeline

Diese Variable enthält die Quellversion, die von bereitgestellt wurdeCodePipeline.

WennCodePipeline die Quellversion nicht aufgelöst werden kann, z. B. wenn es sich bei der Quelle um einen Amazon S3 S3-Bucket handelt, für den die Versionierung nicht aktiviert ist, wird diese Umgebungsvariable nicht gesetzt.

Amazon S3

Diese Variable ist nicht gesetzt.

Falls zutreffend, ist dieCODEBUILD_RESOLVED_SOURCE_VERSION Variable erst nach derDOWNLOAD_SOURCE Phase verfügbar.

CODEBUILD_SOURCE_REPO_URL

Die URL zum Eingabeartefakt oder Quellcode-Repository. Für Amazon S3s3:// folgen darauf der Bucket-Name und der Pfad zum Eingabeartefakt. FürCodeCommit undGitHub ist dies die Klon-URL des Repositorys. Wenn ein Build von stammtCodePipeline, kann diese Umgebungsvariable leer sein.

Für sekundäre Quellen lautet die Umgebungsvariable für die URL des sekundären Quell-RepositorysCODEBUILD_SOURCE_REPO_URL_<sourceIdentifier>, wo<sourceIdentifier> ist die Quell-ID, die Sie erstellen.

CODEBUILD-QUELLVERSION

Das Format des Werts hängt vom Quell-Repository ab.

  • Für Amazon S3 ist dies die Versions-ID, die dem Eingabeartefakt zugeordnet ist.

  • Bei CodeCommit handelt es sich um die Commit-ID oder den Branch-Namen, der zur Version des zu erstellenden Quellcodes gehört.

  • FürGitHubGitHub Enterprise Server und Bitbucket ist es Commit-ID, Branch-Name oder Tag-Name, die/der der Version des Quellcodes entspricht, die Sie erstellen möchten.

    Anmerkung

    Für einenGitHub oderGitHub Enterprise Server-Build, der durch ein Webhook-Pull-Request-Ereignis ausgelöst wird, ist dies der Fallpr/pull-request-number.

Für sekundäre Quellen lautet die Umgebungsvariable für die sekundäre QuellversionCODEBUILD_SOURCE_VERSION_<sourceIdentifier>, wo<sourceIdentifier> ist die Quell-ID, die Sie erstellen. Weitere Informationen finden Sie unter Beispiel für mehrere Eingabequellen und Ausgabeartefakte.

CODEBUILD_SRC_DIR

Der Verzeichnispfad, der für den BuildCodeBuild verwendet wird (z. B./tmp/src123456789/src).

Für sekundäre Quellen lautet die Umgebungsvariable für den sekundären QuellverzeichnispfadCODEBUILD_SRC_DIR_<sourceIdentifier>, wo<sourceIdentifier> ist die Quell-ID, die Sie erstellen. Weitere Informationen finden Sie unter Beispiel für mehrere Eingabequellen und Ausgabeartefakte.

STARTZEIT DES CODEBUILDS

Die als Unix-Zeitstempel angegebene Startzeit des Builds in Millisekunden.

CODEBUILD_WEBHOOK_ACTOR_ACCOUNT_ID

Die Konto-ID des Benutzers, der das Webhook-Ereignis ausgelöst hat.

CODEBUILD_WEBHOOK_BASE_REF

Der Basisreferenzname des Webhook-Ereignisses, das den aktuellen Build auslöst. Bei einer Pull-Anforderung handelt es sich hierbei um die Verzweigungsreferenz.

CODEBUILD_WEBHOOK_EVENT

Das Webhook-Ereignis, das den aktuellen Build auslöst.

CODEBUILD_WEBHOOK_MERGE_COMMIT

Die ID des Merge-Commits, der für den Build verwendet wurde. Diese Variable wird gesetzt, wenn ein Bitbucket-Pull-Request mit der Squash-Strategie zusammengeführt wird und der Pull-Request-Zweig geschlossen wird. In diesem Fall existiert der ursprüngliche Pull-Request-Commit nicht mehr, daher enthält diese Umgebungsvariable den Identifier des gequetschten Merge-Commits.

CODEBUILD_WEBHOOK_PREV_COMMIT

Die ID des letzten Commits vor dem Webhook-Push-Ereignis, das den aktuellen Build auslöst.

CODEBUILD_WEBHOOK_HEAD_REF

Der Hauptreferenzname des Webhook-Ereignisses, das den aktuellen Build auslöst. Hierbei kann es sich um eine Verzweigungsreferenz oder um eine Tag-Referenz handeln.

CODEBUILD_WEBHOOK_TRIGGER

Zeigt das Webhook-Ereignis an, das den Build ausgelöst hat. Diese Variable ist nur für Builds verfügbar, die von einem Webhook ausgelöst wurden. Der Wert wird anhand der Payload analysiertGitHub, dieCodeBuild vonGitHub Enterprise Server oder Bitbucket gesendet wurde. Der Wert des Formats hängt davon ab, welche Art von Ereignis den Build ausgelöst hat.

  • Für Builds, die von einer Pull-Anforderung ausgelöst wurden, handelt es sich um pr/pull-request-number.

  • Für Builds, die durch das Erstellen eines neuen Branches oder durch Pushen eines Commits für einen Branch ausgelöst wurden, handelt es sich um branch/branch-name.

  • Für Builds, die durch das Pushen eines Tags in ein Repository ausgelöst wurden, handelt es sich um tag/tag-name.

ZUHAUSE

Diese Umgebungsvariable ist immer auf gesetzt/root.

Sie können auch Build-Umgebungen mit Ihren eigenen Umgebungsvariablen liefern. Weitere Informationen finden Sie unter den folgenden Themen:

Zur Auflistung der verfügbaren Umgebungsvariablen in einer Build-Umgebung können Sie während eines Builds den Befehl printenv ausführen (für eine Linux-basierte Build-Umgebung), oder "Get-ChildItem Env:" (für Windows-basierte Build-Umgebungen). Mit Ausnahme der vorstehend aufgeführten Umgebungsvariablen sind die mit CODEBUILD_ beginnenden Umgebungsvariablen nur für die interne Nutzung in CodeBuild bestimmt. Diese sollten nicht in Ihrem Build-Befehlen eingesetzt werden.

Wichtig

Wir raten dringend von der Verwendung von Umgebungsvariablen zum Speichern sensibler Werte, insbesondere vonAWS Zugriffsschlüssel-IDs, ab. Umgebungsvariablen können mit Tools wie der CodeBuild-Konsole und über die AWS CLI im Klartext angezeigt werden.

Wir empfehlen Ihnen, vertrauliche Werte im Amazon EC2 Systems Manager Parameter Store zu speichern und sie dann aus Ihrer Buildspec abzurufen. Informationen zum Speichern vertraulicher Werte finden Sie unter Systems Manager Parameter Store and Walkthrough: Create and test a String-Parameter (Konsole) im Amazon EC2 Systems Manager Manager-Benutzerhandbuch. Informationen zum Abrufen dieser Variablen finden Sie unter der parameter-store-Zuordnung in Syntax der Build-Spezifikation.