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 stellt mehrere Umgebungsvariablen bereit, die Sie in Ihren Build-Befehlen verwenden können:

AWS_DEFAULT_REGION

Die AWS 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

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

CODEBUILD_BATCH_BUILD_IDENTIFIER

Der Bezeichner 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) des Builds (z. B.arn:aws:codebuild:region-ID:account-ID:build/codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE).

CODEBUILD_ BUILD _ID

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

CODEBUILD_BUILD_IMAGE

Die CodeBuild Build-Image-ID (zum Beispielaws/codebuild/standard:2.0).

CODEBUILD_BUILD_NUMBER

Die aktuelle Buildnummer für das Projekt.

CODEBUILD_BUILD_SUCCEEDING

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 der Build CodePipeline gestartet wurde, ist dies der Name der Pipeline (z. B.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 den Build CodeBuild gestartet hat, ist dies die Zeichenfolge. CodeBuild-Jenkins-Plugin

CODEBUILD_ _ _ID KMS KEY

Die Kennung des AWS KMS Schlüssels, mit dem das Build-Ausgabeartefakt verschlüsselt CodeBuild wird (z. B. arn:aws:kms:region-ID:account-ID:key/key-ID oder). alias/key-alias

CODEBUILD_LOG_PATH

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

CODEBUILD_PUBLIC_BUILD_URL

Die URL 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 Holen Sie sich ein öffentliches Build-Projekt URLs.

CODEBUILD_RESOLVED_SOURCE_VERSION

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

CodeCommit, GitHub, GitHub Enterprise Server und Bitbucket

Diese Variable enthält die Commit-ID.

CodePipeline

Diese Variable enthält die Quellversion, die von bereitgestellt wurde CodePipeline.

Wenn CodePipeline die Quellrevision 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, ist diese Umgebungsvariable nicht gesetzt.

Amazon S3

Diese Variable ist nicht gesetzt.

Gegebenenfalls ist die CODEBUILD_RESOLVED_SOURCE_VERSION Variable erst nach der DOWNLOAD_SOURCE Phase verfügbar.

CODEBUILD_SOURCE_REPO_URL

Das URL zum Eingabeartefakt- oder Quellcode-Repository. Für Amazon S3 s3:// folgen darauf der Bucket-Name und der Pfad zum Eingabeartefakt. Für CodeCommit und GitHub ist dies der Klon URL des Repositorys. Wenn ein Build von stammt CodePipeline, kann diese Umgebungsvariable leer sein.

Bei sekundären Quellen URL ist die Umgebungsvariable für das sekundäre Quell-RepositoryCODEBUILD_SOURCE_REPO_URL_<sourceIdentifier>, wo sich die Quell-ID <sourceIdentifier> befindet, die Sie erstellen.

CODEBUILD_SOURCE_VERSION

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

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

  • Denn CodeCommit es ist die Commit-ID oder der Branch-Name, der der Version des zu erstellenden Quellcodes zugeordnet ist.

  • Für GitHub GitHub Enterprise Server und Bitbucket ist es die Commit-ID, der Branch-Name oder der Tag-Name, der mit der Version des zu erstellenden Quellcodes verknüpft ist.

    Anmerkung

    Bei einem Build GitHub oder GitHub Enterprise Server, der durch ein Webhook-Pull-Request-Ereignis ausgelöst wird, ist dies der Fall. pr/pull-request-number

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

CODEBUILD_SRC_DIR

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

Bei sekundären Quellen lautet die Umgebungsvariable für den sekundären Quellverzeichnispfad. Dabei handelt <sourceIdentifier> es sich um die Quell-IDCODEBUILD_SRC_DIR_<sourceIdentifier>, die Sie erstellen. Weitere Informationen finden Sie unter Beispiel für mehrere Eingabequellen und Ausgabeartefakte.

CODEBUILD_START_TIME

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

CODEBUILD_ _ _ _ID WEBHOOK ACTOR ACCOUNT

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

Der Bezeichner 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 und der Pull-Request-Branch geschlossen wird. In diesem Fall ist der ursprüngliche Pull-Request-Commit nicht mehr vorhanden, sodass diese Umgebungsvariable den Identifier des gequetschten Merge-Commits enthält.

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 aus der Payload analysiert GitHub, an die GitHub Enterprise Server CodeBuild 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.

HOME

Diese Umgebungsvariable ist immer auf gesetzt. /root

AWS CodeBuild unterstützt auch eine Reihe von Umgebungsvariablen für selbst gehostete Runner-Builds. Weitere Informationen über CodeBuild selbst gehostete Runner finden Sie unter. Tutorial: Einen CodeBuild -gehosteten GitHub Actions-Runner konfigurieren

CODEBUILD_RUNNER_OWNER

Der Besitzer des Repositorys, das den selbst gehosteten Runner-Build auslöst.

CODEBUILD_RUNNER_REPO

Der Name des Repositorys, das den selbst gehosteten Runner-Build auslöst.

CODEBUILD_RUNNER_REPO_DOMAIN

Die Domain des Repositorys, das den selbst gehosteten Runner-Build auslöst. Nur bestimmte GitHub Enterprise-Builds.

CODEBUILD_WEBHOOK_LABEL

Das Label, das zur Konfiguration von Build-Overrides und des selbst gehosteten Runners während des Builds verwendet wird.

CODEBUILD_ _ _ID WEBHOOK RUN

Die Ausführungs-ID des Workflows, der dem Build zugeordnet ist.

CODEBUILD_ WEBHOOK _ JOB _ID

Die Job-ID des Jobs, der dem Build zugeordnet ist.

CODEBUILD_WEBHOOK_WORKFLOW_NAME

Der Name des Workflows, der dem Build zugeordnet ist, falls er in der Payload der Webhook-Anforderung vorhanden ist.

CODEBUILD_RUNNER_WITH_BUILDSPEC

Wenn in den Labels der selbst gehosteten Runner-Anforderung ein Buildspec-Override konfiguriert ist, wird dieser Wert auf gesetzt. true

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 zuvor aufgeführten sind Umgebungsvariablen, die mit CODEBUILD_ beginnen, für den internen Gebrauch bestimmt. CodeBuild Diese sollten nicht in Ihrem Build-Befehlen eingesetzt werden.

Wichtig

Wir raten dringend davon ab, Umgebungsvariablen zum Speichern sensibler Werte, insbesondere von AWS ZugriffsschlüsselnIDs, zu verwenden. Umgebungsvariablen können mithilfe von Tools wie der CodeBuild Konsole und dem im Klartext angezeigt werden. AWS CLI

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