View a markdown version of this page

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

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 den AWS SDKs verwendet.

CODEBUILD_BATCH_BUILD_IDENTIFIER

Der Bezeichner des Builds in einem Batch-Build. Dies ist in der Batch-Buildspec angegeben. Weitere Informationen finden Sie unter Buildspec-Referenz für Batch-Builds.

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 (z. B.). codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE

CODEBUILD_BUILD_IMAGE

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

CODEBUILD_BUILD_NUMBER

Die aktuelle Build-Nummer für das Projekt.

CODEBUILD_BUILD_SUCCESSING

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 (zum Beispielcodepipeline/my-demo-pipeline). Wenn ein Benutzer den Build gestartet hat, ist dies der Name des Benutzers (z. B.MyUserName). Wenn das Jenkins-Plugin den Build CodeBuild gestartet hat, ist dies die Zeichenfolge. CodeBuild-Jenkins-Plugin

CODEBUILD_KMS_KEY_ID

Der Bezeichner des AWS KMS Schlüssels, der zum Verschlüsseln des Build-Ausgabeartefakts verwendet CodeBuild wird (z. B. oder). arn:aws:kms:region-ID:account-ID:key/key-ID alias/key-alias

CODEBUILD_PROJECT_ARN

Der Amazon-Ressourcenname (ARN) des Projekts (z. B.). arn:aws:codebuild:region-ID:account-ID:project/project-name

CODEBUILD_PUBLIC_BUILD_URL

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

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 Quellrevision, die von bereitgestellt wird CodePipeline.

Wenn CodePipeline die Quellrevision nicht aufgelöst werden kann, z. B. wenn es sich bei der Quelle um einen Amazon S3-Bucket handelt, für den die Versionierung nicht aktiviert ist, wird 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

Die URL zum Eingabeartefakt oder Quellcode-Repository. Bei Amazon S3 s3:// folgen darauf der Bucket-Name und der Pfad zum Eingabe-Artefakt. Für CodeCommit und GitHub ist dies die Clone-URL des Repositorys. Wenn ein Build von stammt CodePipeline, ist diese Umgebungsvariable möglicherweise leer.

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_SOURCE_VERSION

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

  • Für Amazon S3 ist dies die Versions-ID, die dem Eingabe-Artefakt 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 der Version des zu erstellenden Quellcodes zugeordnet ist.

    Anmerkung

    Für einen GitHub oder GitHub Enterprise Server-Build, der durch ein Webhook-Pull-Request-Ereignis ausgelöst wird, ist dies der Fall. pr/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 Build CodeBuild 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.

CODEBUILD_START_TIME

Die Startzeit des Builds, angegeben als Unix-Zeitstempel 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

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 existiert der ursprüngliche Pull-Request-Commit nicht mehr, daher enthält diese Umgebungsvariable den Bezeichner des Squash-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 Head-Referenzname 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 analysiert GitHub, die von GitHub Enterprise Server oder CodeBuild Bitbucket an ihn 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.

NACH HAUSE

Diese Umgebungsvariable ist immer auf gesetzt/root.

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

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, die den selbst gehosteten Runner-Build auslöst. Nur angegebene GitHub Enterprise-Builds.

CODEBUILD_WEBHOOK_LABEL

Das Label, das verwendet wird, um Build-Overrides und den selbst gehosteten Runner während des Builds zu konfigurieren.

CODEBUILD_WEBHOOK_RUN_ID

Die Run-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 Nutzlast der Webhook-Anforderung vorhanden ist.

CODEBUILD_RUNNER_WITH_BUILDSPEC

Wenn in den selbst gehosteten Runner-Anforderungslabels eine Buildspec-Überschreibung konfiguriert ist, ist diese auf gesetzt. true

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

Um alle verfügbaren Umgebungsvariablen in einer Build-Umgebung aufzulisten, können Sie den printenv Befehl (für die Linux-based Build-Umgebung) oder "Get-ChildItem Env:" (für Build-Umgebungen) während Windows-based eines Builds ausführen. Mit Ausnahme der zuvor aufgeführten Variablen CODEBUILD_ sind Umgebungsvariablen, die mit beginnen, für den CodeBuild internen Gebrauch bestimmt. Diese sollten nicht in Ihrem Build-Befehlen eingesetzt werden.

Wichtig

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

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-Parameterspeicher und exemplarische Vorgehensweise: Erstellen und testen Sie einen String-Parameter (Konsole) im Amazon EC2 Systems Manager-Benutzerhandbuch. Informationen zum Abrufen dieser Variablen finden Sie unter der parameter-store-Zuordnung in Syntax der Build-Spezifikation.

CODEBUILD_BUILD_URL

Die URL der Buildergebnisse für diesen Build.