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.
Build-Spezifikationsreferenz für CodeBuild
Dieses Thema stellt wichtige Referenzinformationen über Build-Spezifikationsdateien (buildspecs) bereit. Eine Build-Spezifikation ist eine Sammlung von Build-Befehlen und zugehörigen Einstellungen im YAML-Format, die CodeBuild verwendet, um einen Build auszuführen. Sie können eine Build-Spezifikation in den Quellcode aufnehmen oder eine Build-Spezifikation definieren, wenn Sie ein Build-Projekt erstellen. Informationen zur Funktionsweise einer Build-Spezifikation finden Sie unter Funktionsweise von CodeBuild.
Themen
Dateiname der Build-Spezifikation und Speicherort
Wenn Sie eine Build-Spezifikation als Teil des Quellcodes einbinden, muss die Build-Spezifikationsdatei standardmäßig als buildspec.yml
benannt und im Stammverzeichnis Ihres Quellverzeichnisses abgelegt werden.
Sie können den Standard-Namen und -Speicherort der Build-Spezifikationsdatei überschreiben. Beispielsweise ist Folgendes möglich:
-
Verwenden Sie eine andere Build-Spezifikationsdatei für verschiedene Builds im selben Repository, z. B.
buildspec_debug.yml
undbuildspec_release.yml
. -
Speichern Sie eine Build-Spezifikationsdatei in einem anderen Verzeichnis als dem Stammverzeichnis des Quellverzeichnisses, also z. B. in
config/buildspec.yml
oder in einem S3-Bucket. Der S3-Bucket muss sich in derselben AWS Region wie Ihr Build-Projekt befinden. Geben Sie die buildspec-Datei mit ihrem ARN an (z. B.arn:aws:s3:::
).<my-codebuild-sample2>
/buildspec.yml
Sie können für ein Build-Projekt nur ein Build-Spezifikation angeben, unabhängig vom Namen der Build-Spezifikationsdatei.
Führen Sie einen der folgenden Schritte aus, um den Standard-Dateinamen, -Speicherort der Build-Spezifikationsdatei oder beides zu überschreiben:
-
Führen Sie den AWS CLI
create-project
update-project
Befehl oder aus und legen Sie denbuildspec
Wert auf den Pfad zur alternativen buildspec-Datei relativ zum Wert der integrierten Umgebungsvariablen festCODEBUILD_SRC_DIR
. Sie können das Äquivalent auch mit der -create project
Operation in den - AWS SDKs durchführen. Weitere Informationen finden Sie unter Erstellen eines Build-Projekts oder Ändern der Einstellungen eines Build-Projekts. -
Führen Sie den AWS CLI
start-build
Befehl aus und legen Sie denbuildspecOverride
Wert auf den Pfad zur alternativen buildspec-Datei relativ zum Wert der integrierten Umgebungsvariablen festCODEBUILD_SRC_DIR
. Sie können das Äquivalent auch mit der -start build
Operation in den - AWS SDKs durchführen. Weitere Informationen finden Sie unter Ausführen eines Build. -
Legen Sie in einer - AWS CloudFormation Vorlage die -
BuildSpec
Eigenschaft vonSource
in einer Ressource vom TypAWS::CodeBuild::Project
auf den Pfad zur alternativen buildspec-Datei relativ zum Wert der integrierten Umgebungsvariablen festCODEBUILD_SRC_DIR
. Weitere Informationen finden Sie in der BuildSpec -Eigenschaft in der AWS CodeBuild Projektquelle im AWS CloudFormation -Benutzerhandbuch.
Syntax der Build-Spezifikation
Build-Spezifikationsdateien müssen im Format YAML
Wenn ein Befehl ein Zeichen oder eine Zeichenfolge enthält, die von YAML nicht unterstützt wird, müssen Sie den Befehl in Anführungszeichen ("") einschließen. Der folgende Befehl ist in Anführungszeichen eingeschlossen, da ein Doppelpunkt (:) gefolgt von einem Leerzeichen in YAML nicht erlaubt ist. Das Anführungszeichen im Befehl wird mit Escape (\") angegeben.
"export PACKAGE_NAME=$(cat package.json | grep name | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g')"
Die Build-Spezifikation hat die folgende Syntax:
version: 0.2 run-as:
Linux-user-name
env: shell:shell-tag
variables:key
: "value
"key
: "value
" parameter-store:key
: "value
"key
: "value
" exported-variables: -variable
-variable
secrets-manager:key
:secret-id
:json-key
:version-stage
:version-id
git-credential-helper: no | yes proxy: upload-artifacts: no | yes logs: no | yes batch: fast-fail: false | true # build-list: # build-matrix: # build-graph: phases: install: run-as:Linux-user-name
on-failure: ABORT | CONTINUE runtime-versions:runtime
:version
runtime
:version
commands: -command
-command
finally: -command
-command
# steps: pre_build: run-as:Linux-user-name
on-failure: ABORT | CONTINUE commands: -command
-command
finally: -command
-command
# steps: build: run-as:Linux-user-name
on-failure: ABORT | CONTINUE commands: -command
-command
finally: -command
-command
# steps: post_build: run-as:Linux-user-name
on-failure: ABORT | CONTINUE commands: -command
-command
finally: -command
-command
# steps: reports:report-group-name-or-arn
: files: -location
-location
base-directory:location
discard-paths: no | yes file-format:report-format
artifacts: files: -location
-location
name:artifact-name
discard-paths: no | yes base-directory:location
exclude-paths:excluded paths
enable-symlinks: no | yes s3-prefix:prefix
secondary-artifacts:artifactIdentifier
: files: -location
-location
name:secondary-artifact-name
discard-paths: no | yes base-directory:location
artifactIdentifier
: files: -location
-location
discard-paths: no | yes base-directory:location
cache: paths: -path
-path
Die Build-Spezifikation enthält Folgendes:
version
Erforderliche Zuweisung. Diese steht für die Version der Build-Spezifikation. Wir empfehlen Ihnen, 0.2
zu verwenden.
Anmerkung
Obwohl Version 0.1 wird weiterhin unterstützt wird, empfehlen wir Ihnen, nach Möglichkeit Version 0.2 zu verwenden. Weitere Informationen finden Sie unter Versionen der Build-Spezifikationen.
run-as
Optionale Sequenz. Nur für Linux-Benutzer verfügbar. Gibt einen Linux-Benutzer an, der Befehle in dieser buildspec-Datei ausführt. run-as
erteilt dem angegebenen Benutzer Lese- und Ausführungsberechtigungen. Wenn Sie run-as
zu Beginn der buildspec-Datei angeben, gilt die Einstellung global für alle Befehle. Wenn Sie nicht möchten, dass ein Benutzer Berechtigungen für sämtliche Befehle in der buildspec-Datei erhält, können Sie die Berechtigungen auf eine Phase beschränken, indem Sie run-as
in einem der phases
-Blöcke angeben. Wird run-as
nicht angegeben, werden alle Befehle als Root-Benutzer ausgeführt.
env
Optionale Sequenz. Diese steht für die Informationen von einer oder mehrerer benutzerdefinierter Umgebungsvariablen.
Anmerkung
Um vertrauliche Informationen zu schützen, werden die folgenden in CodeBuild Protokollen ausgeblendet:
-
AWS -Zugriffsschlüssel-IDs . Weitere Informationen finden Sie unter Verwalten von Zugriffsschlüsseln für IAM-Benutzer im AWS Identity and Access Management -Benutzerhandbuch.
-
Mit dem Parameter Store angegebene Zeichenfolgen. Weitere Informationen finden Sie unter Systems Manager Parameter Store und Systems Manager Parameter Store Console Walkthrough im Amazon EC2 Systems Manager-Benutzerhandbuch.
-
Zeichenfolgen, die mit angegeben wurden AWS Secrets Manager. Weitere Informationen finden Sie unter Schlüsselverwaltung.
- env/shell
-
Optionale Sequenz. Gibt die unterstützte Shell für Linux- oder Windows-Betriebssysteme an.
Für Linux-Betriebssysteme werden folgende Shell-Tags unterstützt:
-
bash
-
/bin/sh
Für Windows-Betriebssysteme werden folgende Shell-Tags unterstützt:
-
powershell.exe
-
cmd.exe
-
- env/variables
-
Erforderlich, wenn
env
angegeben ist und Sie benutzerdefinierte Umgebungsvariablen im Klartext definieren möchten. Enthält eine Zuweisung vonSchlüssel
/Wert-
Skalaren, wobei jede Zuweisung für eine einzige, benutzerdefinierte Umgebungsvariable in Klartext steht.key (Schlüssel)
ist der Name der benutzerdefinierten Umgebungsvariablen undvalue (Wert)
ist der Wert dieser Variablen.Wichtig
Es wird dringend davon abgeraten, sensible Werte in Umgebungsvariablen zu speichern. Umgebungsvariablen können in Klartext mithilfe von Tools wie der CodeBuild Konsole und der angezeigt werden AWS CLI. Für vertrauliche Werte sollte stattdessen die Zuweisung per
parameter-store
odersecrets-manager
verwendet werden (siehe unten in diesem Abschnitt).Jede festgelegte Umgebungsvariable ersetzt vorhandene Umgebungsvariablen. Wenn das Docker-Image beispielsweise bereits eine Umgebungsvariable mit dem Namen
MY_VAR
und einem Wert vonmy_value
enthält und Sie eine Umgebungsvariable mit dem NamenMY_VAR
und einem Wert vonother_value
festlegen, wirdmy_value
durchother_value
ersetzt. Wenn das Docker-Image demgegenüber bereits eine Umgebungsvariable mit dem NamenPATH
und einem Wert von/usr/local/sbin:/usr/local/bin
enthält und Sie eine Umgebungsvariable mit dem NamenPATH
und einem Wert von$PATH:/usr/share/ant/bin
festlegen, wird/usr/local/sbin:/usr/local/bin
durch den Literalwert$PATH:/usr/share/ant/bin
ersetzt.Legen Sie keine Umgebungsvariable mit einem Namen fest, der mit
CODEBUILD_
beginnt. Dieses Präfix ist zur -internen Verwendung reserviert.Wenn eine Umgebungsvariable mit identischem Namen an mehreren Orten definiert ist, wird der Wert folgendermaßen bestimmt:
-
Der Wert im Aufruf zum Starten des Build-Vorgangs hat den höchsten Vorrang. Beim Erstellen eines Builds können Sie Umgebungsvariablen hinzufügen oder überschreiben. Weitere Informationen finden Sie unter Ausführen eines Build in AWS CodeBuild.
-
Der Wert in der Build-Projektdefinition folgt darauf. Beim Erstellen oder Bearbeiten eines Projekts können Sie Umgebungsvariablen auf Projektebene hinzufügen. Weitere Informationen finden Sie unter Erstellen eines Build-Projekts in AWS CodeBuild und Ändern der Einstellungen eines Build-Projekts in AWS CodeBuild.
-
Der Wert in der buildspec-Deklaration hat die niedrigste Priorität.
-
- env/parameter-store
-
Erforderlich, wenn angegeben
env
ist und Sie benutzerdefinierte Umgebungsvariablen abrufen möchten, die im Amazon EC2 Systems Manager Parameter Store gespeichert sind. Enthält eine Zuordnung vonSchlüssel
-/Wertskalaren
, wobei jede Zuordnung eine einzelne benutzerdefinierte Umgebungsvariable darstellt, die im Amazon EC2 Systems Manager Parameter Store gespeichert ist.Schlüssel
ist der Name, den Sie später in Ihren Build-Befehlen verwenden, um auf diese benutzerdefinierte Umgebungsvariable zu verweisen, undWert
ist der Name der benutzerdefinierten Umgebungsvariablen, die im Amazon EC2 Systems Manager Parameter Store gespeichert ist. Informationen zum Speichern sensibler Werte finden Sie unter Systems Manager Parameter Store und Walkthrough: Erstellen und Testen eines Zeichenfolgenparameters (Konsole) im Amazon EC2 Systems Manager-Benutzerhandbuch.Wichtig
Damit benutzerdefinierte Umgebungsvariablen abrufen kann CodeBuild , die im Amazon EC2 Systems Manager Parameter Store gespeichert sind, müssen Sie die
ssm:GetParameters
Aktion zu Ihrer CodeBuild Servicerolle hinzufügen. Weitere Informationen finden Sie unter Erstellen Sie eine CodeBuild Servicerolle.Alle Umgebungsvariablen, die Sie aus Amazon EC2 Systems Manager Parameter Store abrufen, ersetzen vorhandene Umgebungsvariablen. Wenn das Docker-Image beispielsweise bereits eine Umgebungsvariable mit dem Namen
MY_VAR
und einem Wert vonmy_value
enthält und Sie eine Umgebungsvariable mit dem NamenMY_VAR
und einem Wert vonother_value
abrufen, wirdmy_value
durchother_value
ersetzt. Wenn das Docker-Image demgegenüber bereits eine Umgebungsvariable mit dem NamenPATH
und einem Wert von/usr/local/sbin:/usr/local/bin
enthält und Sie eine Umgebungsvariable mit dem NamenPATH
und einem Wert von$PATH:/usr/share/ant/bin
abrufen, wird/usr/local/sbin:/usr/local/bin
durch den Literalwert$PATH:/usr/share/ant/bin
ersetzt.Speichern Sie keine Umgebungsvariable mit einem Namen, der mit
CODEBUILD_
beginnt. Dieses Präfix ist zur -internen Verwendung reserviert.Wenn eine Umgebungsvariable mit identischem Namen an mehreren Orten definiert ist, wird der Wert folgendermaßen bestimmt:
-
Der Wert im Aufruf zum Starten des Build-Vorgangs hat den höchsten Vorrang. Beim Erstellen eines Builds können Sie Umgebungsvariablen hinzufügen oder überschreiben. Weitere Informationen finden Sie unter Ausführen eines Build in AWS CodeBuild.
-
Der Wert in der Build-Projektdefinition folgt darauf. Beim Erstellen oder Bearbeiten eines Projekts können Sie Umgebungsvariablen auf Projektebene hinzufügen. Weitere Informationen finden Sie unter Erstellen eines Build-Projekts in AWS CodeBuild und Ändern der Einstellungen eines Build-Projekts in AWS CodeBuild.
-
Der Wert in der buildspec-Deklaration hat die niedrigste Priorität.
-
- env/secrets-manager
-
Erforderlich, wenn Sie benutzerdefinierte Umgebungsvariablen abrufen möchten, die in gespeichert sind AWS Secrets Manager. Geben Sie einen Secrets Manager
reference-key
mit dem folgenden Muster an:
:<key>
<secret-id>
:<json-key>
:<version-stage>
:<version-id>
<Schlüssel>
-
(Erforderlich) Der Name der lokalen Umgebungsvariablen. Verwenden Sie diesen Namen, um während des Builds auf die Variable zuzugreifen.
<secret-id>
-
(Erforderlich) Der Name oder der Amazon-Ressourcenname (ARN), der als eindeutige Kennung für das Secret dient. Um auf ein Secret in Ihrem AWS -Konto zuzugreifen, geben Sie einfach den Secret-Namen an. Um auf ein Secret in einem anderen AWS Konto zuzugreifen, geben Sie den Secret-ARN an.
<json-key>
-
(Optional) Gibt den Schlüsselnamen des Secrets-Manager-Schlüssel-Wert-Paares an, dessen Wert Sie abrufen möchten. Wenn Sie keinen angeben
json-key
, ruft den gesamten Secret-Text CodeBuild ab. <version-stage>
-
(Optional) Gibt die Secret-Version an, die Sie abrufen möchten, durch das Staging-Label, das der Version zugeordnet ist. Staging-Kennzeichnungen werden verwendet, um während des Rotationsprozesses den Überblick über verschiedene Versionen zu behalten. Wenn Sie
version-stage
verwenden, geben Sieversion-id
nicht an. Wenn Sie keine Versionsstufe oder Versions-ID angeben, wird standardmäßig die Version mit dem VersionsstufenwertAWSCURRENT
abgerufen. <version-id>
-
(Optional) Gibt die eindeutige Kennung der Version des Secrets an, die Sie verwenden möchten. Wenn Sie
version-id
angeben, dürfen Sieversion-stage
nicht angeben. Wenn Sie keine Versionsstufe oder Versions-ID angeben, wird standardmäßig die Version mit dem VersionsstufenwertAWSCURRENT
abgerufen.
Im folgenden Beispiel
TestSecret
ist der Name des Schlüssel-Wert-Paares, das in Secrets Manager gespeichert ist. Der Schlüssel fürTestSecret
istMY_SECRET_VAR
. Sie greifen während des Builds mit demLOCAL_SECRET_VAR
Namen auf die Variable zu.env: secrets-manager: LOCAL_SECRET_VAR: "TestSecret:MY_SECRET_VAR"
Weitere Informationen finden Sie unter Was ist AWS Secrets Manager? im AWS Secrets Manager -Benutzerhandbuch.
- env/exported-variables
-
Optionale Zuweisung. Wird verwendet, um Umgebungsvariablen aufzulisten, die Sie exportieren möchten. Geben Sie den Namen jeder Variable, die Sie exportieren möchten, unter
exported-variables
in einer separaten Zeile an. Die Variable, die Sie exportieren möchten, muss während des Builds in Ihrem Container verfügbar sein. Die Variable, die Sie exportieren, kann eine Umgebungsvariable sein.Exportierte Umgebungsvariablen werden in Verbindung mit verwendet AWS CodePipeline , um Umgebungsvariablen aus der aktuellen Build-Phase in nachfolgende Phasen der Pipeline zu exportieren. Weitere Informationen finden Sie unter Arbeiten mit Variablen im AWS CodePipeline -Benutzerhandbuch.
Während eines Builds ist der Wert einer Variablen ab der
install
-Phase verfügbar. Er kann zwischen dem Beginn derinstall
-Phase und dem Ende derpost_build
-Phase aktualisiert werden. Nach dem Ende derpost_build
-Phase kann sich der Wert der exportierten Variablen nicht ändern.Anmerkung
Folgendes kann nicht exportiert werden:
-
Amazon EC2 Systems Manager Parameter Store-Secrets, die im Build-Projekt angegeben wurden.
-
Im Build-Projekt angegebene Secrets Manager-Secrets
-
Umgebungsvariablen, die mit
AWS_
beginnen.
-
- env/git-credential-helper
-
Optionale Zuweisung. Wird verwendet, um anzugeben, ob sein Git-Hilfsprogramm für Anmeldeinformationen CodeBuild verwendet, um Git-Anmeldeinformationen bereitzustellen,
yes
falls es verwendet wird. Andernfallsno
oder nicht angegeben. Weitere Informationen finden Sie unter gitcredentialsauf der Git-Website. Anmerkung
git-credential-helper
wird für Builds, die von einem Webhook für ein öffentliches Git-Repository ausgelöst werden, nicht unterstützt.
Proxy
Optionale Sequenz. Wird verwendet, um Einstellungen darzustellen, wenn Sie Ihren Build in einem expliziten Proxy-Server ausführen. Weitere Informationen finden Sie unter Führen Sie CodeBuild in einem expliziten Proxy-Server aus.
- proxy/upload-artifacts
-
Optionale Zuweisung. Legen Sie diese auf
yes
fest, wenn Ihr Build in einem expliziten Proxy-Server Artefakte hochladen soll. Der Standardwert istno
. - proxy/logs
-
Optionale Zuweisung. Legen Sie auf
yes
fest, damit Ihr Build auf einem expliziten Proxy-Server CloudWatch Protokolle erstellen kann. Der Standardwert istno
.
phases
Erforderliche Sequenz. Stellt die Befehle dar, die während jeder Phase des Builds CodeBuild ausgeführt werden.
Anmerkung
In buildspec Version 0.1 CodeBuild führt jeden Befehl in einer separaten Instance der Standard-Shell in der Build-Umgebung aus. d. h., dass jeder Befehl unabhängig von allen anderen Befehlen ausgeführt wird. Daher können Sie standardmäßig keinen Einzelbefehl ausführen, der auf dem Status eines vorherigen Befehls basiert (beispielsweise beim Ändern von Verzeichnissen oder beim Einrichten von Variablen). Um diese Einschränkung zu umgehen, empfehlen wir die Nutzung von Version 0.2, die dieses Problem löst. Wenn Sie die Build-Spezifikation Version 0.1 verwenden müssen, empfehlen wir die Ansätze in Shells und Befehle in Build-Umgebungen.
- phases/*/run-as
-
Optionale Sequenz. Verwenden Sie den Befehl in einer Build-Phase, um den Linux-Benutzer festzulegen, der die zugehörigen Befehle ausführt. Wenn zusätzlich zu Beginn der buildspec-Datei
run-as
global für alle Befehle angegeben wird, wird dem Benutzer auf Phasenebene Vorrang eingeräumt. Beispiel: Wennrun-as
global User-1 angibt und in derinstall
-Phase einerun-as
-Anweisung User-2 definiert, werden alle Befehle in der buildspec-Datei als User-1 ausgeführt, bis auf die Befehle in derinstall
-Phase, die als User-2 ausgeführt werden. - Phasen/*/bei Ausfall
-
Optionale Sequenz. Gibt die Aktion an, die ausgeführt werden soll, wenn während der -Phase ein Fehler auftritt. Dabei kann es sich um einen der folgenden Werte handeln:
-
ABORT
– Bricht den Build ab. -
CONTINUE
– Fahren Sie mit der nächsten Phase fort.
Wenn diese Eigenschaft nicht angegeben ist, folgt der Fehlerprozess den Übergangsphasen, wie in gezeigtÜbergang von Build-Phasen.
-
- Phasen/*/endgültig
-
Optionaler Block. Befehle, die in einem
finally
Block angegeben sind, werden nach Befehlen imcommands
Block ausgeführt. Die Befehle in einemfinally
Block werden auch dann ausgeführt, wenn ein Befehl imcommands
Block fehlschlägt. Wenn dercommands
Block beispielsweise drei Befehle enthält und der erste fehlschlägt, CodeBuild überspringt die verbleibenden beiden Befehle und führt alle Befehle imfinally
Block aus. Die Phase ist erfolgreich, wenn alle Befehle in den Blöckencommands
undfinally
erfolgreich ausgeführt werden. Wenn ein Befehl in einer Phase fehlschlägt, schlägt die Phase fehl.
Die zulässigen Build-Phasennamen sind:
- phases/install
-
Optionale Sequenz. Stellt die Befehle dar, die während der Installation CodeBuild ausgeführt werden. Wir empfehlen Ihnen, die Phase
install
nur für Installationspakete in der Build-Umgebung einzusetzen. Beispielsweise könnten sie diese Phase nutzen, um ein Code-Testframework wie Mocha oder RSpec zu installieren.- phases/install/runtime-versions
-
Optionale Sequenz. Eine Laufzeitversion wird mit dem Ubuntu-Standard-Image 5.0 oder höher und dem Amazon Linux 2-Standard-Image 4.0 oder höher unterstützt. Wenn dieses Argument angegeben wird, muss mindestens eine Laufzeit in diesen Abschnitt aufgenommen werden. Geben Sie eine Laufzeit mit einer bestimmten Version, eine Hauptversion gefolgt von an,
.x
um anzugeben, dass CodeBuild diese Hauptversion mit ihrer neuesten Nebenversion oder die neueste Haupt- und Nebenversionlatest
verwendet (z. B.ruby: 3.2
nodejs: 18.x
, oderjava: latest
). Sie können die Laufzeit unter Verwendung einer Zahl oder einer Umgebungsvariablen angeben. Wenn Sie beispielsweise das Amazon Linux 2-Standardabbild 4.0 verwenden, gibt Folgendes an, dass Version 17 von Java, die neueste Nebenversion von Python Version 3 und eine Version, die in einer Umgebungsvariablen von Ruby enthalten ist, installiert ist. Weitere Informationen finden Sie unter Von bereitgestellte Docker-Images CodeBuild.phases: install: runtime-versions: java: corretto8 python: 3.x ruby: "$MY_RUBY_VAR"
Sie können eine oder mehrere Laufzeiten im Abschnitt
runtime-versions
Ihrer buildspec-Datei angeben. Wenn Ihre Laufzeit von einer anderen Laufzeit abhängig ist, können Sie auch die abhängige Laufzeit in der buildspec-Datei angeben. Wenn Sie keine Laufzeiten in der buildspec-Datei angeben, CodeBuild wählt die Standardlaufzeiten aus, die in dem von Ihnen verwendeten Image verfügbar sind. Wenn Sie eine oder mehrere Laufzeiten angeben, CodeBuild verwendet nur diese Laufzeiten. Wenn keine abhängige Laufzeit angegeben ist, CodeBuild versucht , die abhängige Laufzeit für Sie auszuwählen.Wenn zwei angegebene Laufzeiten unvereinbar sind, schlägt der Build fehl. Beispiel:
android: 29
undjava: openjdk11
sind miteinander unvereinbar. Wenn beide angegeben werden, schlägt der Build fehl.Weitere Informationen zu den verfügbaren Laufzeiten finden Sie unter Verfügbare Laufzeiten.
Anmerkung
Wenn Sie einen
runtime-versions
Abschnitt angeben und ein anderes Image als Ubuntu Standard Image 2.0 oder höher oder das Amazon Linux 2 (AL2) Standard-Image 1.0 oder höher verwenden, gibt der Build die Warnung „“ ausSkipping install of runtimes. Runtime version selection is not supported by this build image
.
- phases/install/commands
-
Optionale Sequenz. Enthält eine Reihe von Skalaren, wobei jedes Skalar einen einzelnen Befehl darstellt, der während der Installation CodeBuild ausgeführt wird. CodeBuild führt jeden Befehl nacheinander in der aufgeführten Reihenfolge aus.
- phases/pre_build
-
Optionale Sequenz. Stellt die Befehle dar, falls vorhanden, die vor dem Build CodeBuild ausgeführt werden. Sie können diese Phase beispielsweise verwenden, um sich bei Amazon ECR anzumelden, oder Sie können npm-Abhängigkeiten installieren.
- phases/pre_build/commands
-
Erforderliche Sequenz, wenn
pre_build
angegeben ist. Enthält eine Reihe von Skalaren, wobei jedes Skalar einen einzelnen Befehl darstellt, der vor dem Build CodeBuild ausgeführt wird. CodeBuild führt jeden Befehl nacheinander in der aufgeführten Reihenfolge aus.
- phases/build
-
Optionale Sequenz. Stellt die Befehle dar, falls vorhanden, die während des Builds CodeBuild ausgeführt werden. Beispielsweise könnten sie diese Phase nutzen, um Mocha, RSpec oder sbt auszuführen.
- phases/build/commands
-
Erforderlich, wenn angegeben
build
ist. Enthält eine Skalarsequenz, wobei jedes Skalar einen einzelnen Befehl darstellt, der während des Builds CodeBuild ausgeführt wird. CodeBuild führt jeden Befehl nacheinander in der aufgeführten Reihenfolge aus.
- phases/post_build
-
Optionale Sequenz. Stellt die Befehle dar, falls vorhanden, die nach dem Build CodeBuild ausgeführt werden. Beispielsweise können Sie Maven verwenden, um die Build-Artefakte in eine JAR- oder WAR-Datei zu verpacken, oder Sie können ein Docker-Image in Amazon ECR übertragen. Dann können Sie eine Build-Benachrichtigung über Amazon SNS senden.
- phases/post_build/commands
-
Erforderlich, wenn angegeben
post_build
ist. Enthält eine Reihe von Skalaren, wobei jedes Skalar einen einzelnen Befehl darstellt, CodeBuild der nach dem Build ausgeführt wird. CodeBuild führt jeden Befehl nacheinander in der aufgeführten Reihenfolge aus.
Berichte
- report-group-name-or-arn
-
Optionale Sequenz. Gibt die Berichtsgruppe an, an die die Berichte gesendet werden. Ein Projekt kann maximal fünf Berichtsgruppen haben. Geben Sie den ARN für eine vorhandene Berichtsgruppe oder den Namen einer neuen Berichtsgruppe an. Wenn Sie einen Namen angeben, CodeBuild erstellt eine Berichtsgruppe unter Verwendung Ihres Projektnamens und des Namens, den Sie im Format angeben
<project-name>-<report-group-name>
. Der Name der Berichtsgruppe kann auch mithilfe einer Umgebungsvariablen in der Build-Spezifikation wie festgelegt werden$REPORT_GROUP_NAME
. Weitere Informationen finden Sie unter Benennung von Berichtsgruppen. - reports/<report-group>/files
-
Erforderliche Sequenz. Stellt die Speicherorte dar, die die Rohdaten der vom Bericht generierten Testergebnisse enthalten. Enthält eine Reihe von Skalaren, wobei jedes Skalar einen separaten Speicherort darstellt, an dem Testdateien relativ zum ursprünglichen Build-Standort oder, falls festgelegt, finden CodeBuild kann
base-directory
. Speicherorte können Folgendes enthalten:-
Eine Einzeldatei (z. B.
my-test-report-file.json
). -
Eine einzelne Datei in einem Unterverzeichnis (Beispiel:
odermy-subdirectory
/my-test-report-file.json
).my-parent-subdirectory
/my-subdirectory
/my-test-report-file.json -
'**/*'
steht rekursiv für alle Dateien. -
steht für alle Dateien in einem Unterverzeichnis mit Namenmy-subdirectory
/*my-subdirectory
. -
steht rekursiv für alle Dateien beginnend mit einem Unterverzeichnis mit Namenmy-subdirectory
/**/*my-subdirectory
.
-
- reports/<report-group>/file-format
-
Optionale Zuweisung. Stellt das Berichtsdateiformat dar. Wenn nicht angegeben, wird
JUNITXML
verwendet. Bei diesem Wert wird nicht zwischen Groß- und Kleinschreibung unterschieden. Die möglichen Werte sind:Testberichte
-
CUCUMBERJSON
-
Cucumber JSON
-
JUNITXML
-
JUnit XML
-
NUNITXML
-
NUnit XML
-
NUNIT3XML
-
NUnit 3 XML
-
TESTNGXML
-
TestNG XML
-
VISUALSTUDIOTRX
-
Visual Studio TRX
Code-Abdeckungsberichte
-
CLOVERXML
-
Klover-XML
-
COBERTURAXML
-
Coura-XML
-
JACOCOXML
-
JaCoCo XML
-
SIMPLECOV
-
SimpleCov JSON
Anmerkung
CodeBuild akzeptiert JSON-Code-Abdeckungsberichte, die von Simplecov
generiert wurden, nicht Simplecov-json.
-
- reports/<report-group>/base-directory
-
Optionale Zuweisung. Stellt ein oder mehrere Verzeichnisse der obersten Ebene relativ zum ursprünglichen Build-Speicherort dar, die CodeBuild verwendet, um zu bestimmen, wo die Rohtestdateien zu finden sind.
- reports/<report-group>/discard-paths
-
Optional. Gibt an, ob die Berichtsdateiverzeichnisse in der Ausgabe abgeflacht werden. Wenn dies nicht angegeben ist oder
no
enthält, werden Berichtsdateien mit intakter Verzeichnisstruktur ausgegeben. Wenn diesyes
enthält, werden alle Testdateien im selben Ausgabeverzeichnis abgelegt. Wenn beispielsweise ein Pfad zu einem Testergebniscom/myapp/mytests/TestResult.xml
lautet, wird die Datei durch Angabe vonyes
in/TestResult.xml
gespeichert.
Artefakte
Optionale Sequenz. Stellt Informationen darüber dar, wo die Build-Ausgabe finden CodeBuild kann und wie sie für den Upload in den S3-Ausgabe-Bucket CodeBuild vorbereitet. Diese Sequenz ist nicht erforderlich, wenn Sie beispielsweise ein Docker-Image erstellen und an Amazon ECR übertragen oder Einheitentests für Ihren Quellcode ausführen, aber nicht erstellen.
Anmerkung
Amazon-S3-Metadaten haben einen CodeBuild Header mit dem Namen x-amz-meta-codebuild-buildarn
, der den buildArn
des CodeBuild Builds enthält, der Artefakte in Amazon S3 veröffentlicht. Der buildArn
wird hinzugefügt, um die Quellverfolgung für Benachrichtigungen zu ermöglichen und darauf zu verweisen, von welchem Build das Artefakt generiert wird.
- artifacts/files
-
Erforderliche Sequenz. Diese stellt die Speicherorte dar, die die Build-Ausgabeartefakte in der Build-Umgebung enthalten. Enthält eine Sequenz von Skalaren, wobei jeder Skalar für einen einzelnen Speicherort steht, an dem CodeBuild Build-Ausgabeartefakte in Bezug auf die ursprünglichen Build-Speicherorte finden kann, oder, sofern festgelegt, auf das Basisverzeichnis. Speicherorte können Folgendes enthalten:
-
Eine Einzeldatei (z. B.
my-file.jar
). -
Eine einzelne Datei in einem Unterverzeichnis (Beispiel:
odermy-subdirectory
/my-file.jar
).my-parent-subdirectory
/my-subdirectory
/my-file.jar -
'**/*'
steht rekursiv für alle Dateien. -
steht für alle Dateien in einem Unterverzeichnis mit Namenmy-subdirectory
/*my-subdirectory
. -
steht rekursiv für alle Dateien beginnend mit einem Unterverzeichnis mit Namenmy-subdirectory
/**/*my-subdirectory
.
Wenn Sie Speicherorte für Build-Ausgabeartefakte angeben, CodeBuild kann den ursprünglichen Build-Speicherort in der Build-Umgebung finden. Sie müssen die Speicherorte von Build-Ausgabeartefakten mit dem Pfad zu den ursprünglichen Build-Speicherorten nicht voranstellen oder angeben,
./
oder ähnliches. Wenn sie den Pfad zu diesem Speicherort wissen möchten, können Sie während eines Builds ein Befehl ausführen wieecho $CODEBUILD_SRC_DIR
. Der Speicherort für jede Build-Umgebung kann geringfügig voneinander abweichen. -
- artifacts/name
-
Optionaler Name. Gibt einen Namen für Ihr Build-Artefakt an. Dieser Name wird verwendet, wenn eine der folgenden Bedingungen zutrifft.
-
Sie verwenden die CodeBuild API, um Ihre Builds zu erstellen, und das -
overrideArtifactName
Flag wird für dasProjectArtifacts
Objekt gesetzt, wenn ein Projekt aktualisiert, ein Projekt erstellt oder ein Build gestartet wird. -
Sie verwenden die CodeBuild Konsole, um Ihre Builds zu erstellen, ein Name wird in der buildspec-Datei angegeben und wählen Semantisches Versioning aktivieren, wenn Sie ein Projekt erstellen oder aktualisieren. Weitere Informationen finden Sie unter Erstellen Sie ein Build-Projekt (Konsole).
Sie können einen Namen in der Build-Spezifikationsdatei angeben, die zur Build-Zeit berechnet wird. Der in einer Build-Spezifikationsdatei angegebene Name verwendet die Shell-Befehlssprache. Beispielsweise können Sie dem Namen Ihres Artefakts ein Datum und eine Uhrzeit anhängen, damit dieser stets eindeutig ist. Eindeutige Artefakt-Namen verhindern, dass Artefakte überschrieben werden. Weitere Informationen finden Sie unter Shell-Befehlssprache
. -
Dies ist ein Beispiel für einen Artefakt-Namen, dem das Datum angefügt wurde, an dem das Artefakt erstellt wurde.
version: 0.2 phases: build: commands: - rspec HelloWorld_spec.rb artifacts: files: - '**/*' name: myname-$(date +%Y-%m-%d)
-
Dies ist ein Beispiel für einen Artefaktnamen, der eine CodeBuild Umgebungsvariable verwendet. Weitere Informationen finden Sie unter Umgebungsvariablen in Build-Umgebungen.
version: 0.2 phases: build: commands: - rspec HelloWorld_spec.rb artifacts: files: - '**/*' name: myname-$AWS_REGION
-
Dies ist ein Beispiel für einen Artefaktnamen, der eine CodeBuild Umgebungsvariable verwendet, an die das Erstellungsdatum des Artefakts angehängt ist.
version: 0.2 phases: build: commands: - rspec HelloWorld_spec.rb artifacts: files: - '**/*' name: $AWS_REGION-$(date +%Y-%m-%d)
Sie können dem Namen Pfadinformationen hinzufügen, sodass die benannten Artefakte basierend auf dem Pfad im Namen in Verzeichnissen platziert werden. In diesem Beispiel werden Build-Artefakte in der Ausgabe unter platziert
builds/<build number>/my-artifacts
.version: 0.2 phases: build: commands: - rspec HelloWorld_spec.rb artifacts: files: - '**/*' name: builds/$CODEBUILD_BUILD_NUMBER/my-artifacts
-
- artifacts/discard-paths
-
Optional. Gibt an, ob die Build-Artefaktnerzeichnisse in der Ausgabe abgeflacht werden. Wenn dies nicht angegeben ist oder
no
enthält, werden Build-Artefakte mit intakter Verzeichnisstruktur ausgegeben. Wennyes
enthalten ist, werden alle Build-Artefakte im selben Ausgabeverzeichnis platziert. Wenn beispielsweise ein Pfad zu einer Datei im Build-Ausgabeartefaktcom/mycompany/app/HelloWorld.java
ist, wird diese Datei durch Angabe vonyes
in/HelloWorld.java
gespeichert. - artifacts/base-directory
-
Optionale Zuweisung. Stellt ein oder mehrere Verzeichnisse der obersten Ebene relativ zum ursprünglichen Build-Speicherort dar, die CodeBuild verwendet, um zu bestimmen, welche Dateien und Unterverzeichnisse in das Build-Ausgabeartefakt aufgenommen werden sollen. Gültige Werte sind:
-
Ein einziges Top-Level-Verzeichnis (z. B.
my-directory
). -
'my-directory*'
stellt alle Top-Level-Verzeichnisse dar, deren Namen mitmy-directory
beginnen.
Die übereinstimmenden Top-Level-Verzeichnisse werden nicht in den Build-Ausgabeartefakt aufgenommen, sondern nur deren Dateien und Unterverzeichnisse.
Sie können
files
unddiscard-paths
verwenden, um weiter zu beschränken, welche Dateien und Unterverzeichnisse aufgenommen werden. Wie zum Beispiel für die folgende Verzeichnisstruktur:. ├── my-build-1 │ └── my-file-1.txt └── my-build-2 ├── my-file-2.txt └── my-subdirectory └── my-file-3.txt
Und für die folgende Sequenz
artifacts
:artifacts: files: - '*/my-file-3.txt' base-directory: my-build-2
Das folgende Unterverzeichnis und die Datei werden in den Build-Ausgabeartefakt aufgenommen:
. └── my-subdirectory └── my-file-3.txt
Während für die Sequenz
artifacts
Folgendes gilt:artifacts: files: - '**/*' base-directory: 'my-build*' discard-paths: yes
Die folgenden Dateien werden in den Build-Ausgabeartefakt aufgenommen:
. ├── my-file-1.txt ├── my-file-2.txt └── my-file-3.txt
-
- Artefakte/Ausschlusspfade
-
Optionale Zuweisung. Stellt einen oder mehrere Pfade relativ zu dar
base-directory
, die von den Build-Artefakten CodeBuild ausschließen. Das Sternchen (*
) entspricht einem oder mehreren Zeichen einer Namenskomponente ohne Überschreiten der Ordnergrenzen. Ein doppeltes Sternchen (**
) entspricht null oder mehr Zeichen einer Namenskomponente in allen Verzeichnissen.Beispiele für Exclude-Paths sind die folgenden:
-
So schließen Sie eine Datei aus allen Verzeichnissen aus:
"**/
file-name
/**/*" -
So schließen Sie alle Punktordner aus:
"**/.*/**/*"
-
So schließen Sie alle Punktdateien aus:
"**/.*"
-
- Artefakte/Aktivieren-Symlinks
-
Optional. Wenn der Ausgabetyp ist
ZIP
, gibt an, ob interne symbolische Links in der ZIP-Datei beibehalten werden. Wenn dies enthältyes
, werden alle internen symbolischen Links in der Quelle in der Artefakt-ZIP-Datei beibehalten. - Artefakte/S3-Präfix
-
Optional. Gibt ein Präfix an, das verwendet wird, wenn die Artefakte an einen Amazon S3-Bucket ausgegeben werden und der Namespace-Typ ist
BUILD_ID
. Bei Verwendung ist der Ausgabepfad im Bucket<s3-prefix>/<build-id>/<name>.zip
. - artifacts/secondary-artifacts
-
Optionale Sequenz. Repräsentiert einzelne oder mehrere Artefaktdefinitionen als Zuordnung zwischen einem Artefaktbezeichner und einer Artefaktdefinition. Jeder Artefaktbezeichner in diesem Block muss einem im Attribut
secondaryArtifacts
des Projekts definierten Artefakt entsprechen. Jede separate Definition hat die gleiche Syntax wie derartifacts
-Block oben.Anmerkung
Die artifacts/files Sequenz ist immer erforderlich, auch wenn nur sekundäre Artefakte definiert sind.
Angenommen sei ein Projekt mit folgender Struktur:
{ "name": "sample-project", "secondaryArtifacts": [ { "type": "S3", "location": "
<output-bucket1>
", "artifactIdentifier": "artifact1", "name": "secondary-artifact-name-1" }, { "type": "S3", "location": "<output-bucket2>
", "artifactIdentifier": "artifact2", "name": "secondary-artifact-name-2" } ] }Anschließend sieht die buildspec-Datei wie folgt aus:
version: 0.2 phases: build: commands: - echo Building... artifacts: files: - '**/*' secondary-artifacts: artifact1: files: - directory/file1 name: secondary-artifact-name-1 artifact2: files: - directory/file2 name: secondary-artifact-name-2
Cache
Optionale Sequenz. Stellt Informationen darüber dar, wo die Dateien für das Hochladen des Caches in einen S3-Cache-Bucket vorbereiten CodeBuild kann. Diese Sequenz ist nicht erforderlich, wenn der Cache-Typ des Projekts No Cache
ist.
- cache/paths
-
Erforderliche Sequenz. Steht für die Speicherorte des Caches. Enthält eine Reihe von Skalaren, wobei jedes Skalar einen separaten Speicherort darstellt, an dem Build-Ausgabeartefakte relativ zum ursprünglichen Build-Speicherort oder, falls festgelegt, zum Basisverzeichnis finden CodeBuild kann. Speicherorte können Folgendes enthalten:
-
Eine Einzeldatei (z. B.
my-file.jar
). -
Eine einzelne Datei in einem Unterverzeichnis (Beispiel:
odermy-subdirectory
/my-file.jar
).my-parent-subdirectory
/my-subdirectory
/my-file.jar -
'**/*'
steht rekursiv für alle Dateien. -
steht für alle Dateien in einem Unterverzeichnis mit Namenmy-subdirectory
/*my-subdirectory
. -
steht rekursiv für alle Dateien beginnend mit einem Unterverzeichnis mit Namenmy-subdirectory
/**/*my-subdirectory
.
-
Wichtig
Da es sich bei der Build-Spezifikationsdeklaration um eine gültige YAML handelt, ist die Formatierung in einer Build-Spezifikationsdeklaration wichtig. Wenn die Anzahl der Leerzeichen in der Build-Spezifikationsdeklaration unzulässig ist, können die Builds sofort fehlschlagen. Verwenden Sie eine YAML-Validierung, um zu testen, ob es sich bei Ihrer Build-Spezifikationsdeklaration um eine gültige YAML handelt.
Wenn Sie die oder die AWS SDKs verwenden AWS CLI, um eine Build-Spezifikation zu deklarieren, wenn Sie ein Build-Projekt erstellen oder aktualisieren, muss die Build-Spezifikation eine einzelne Zeichenfolge sein, die im YAML-Format ausgedrückt wird, zusammen mit den erforderlichen Leerzeichen und Escape-Zeichen für neue Zeilen. Es folgt ein Beispiel im nächsten Abschnitt.
Wenn Sie die - CodeBuild oder - AWS CodePipeline Konsolen anstelle einer buildspec.yml-Datei verwenden, können Sie Befehle nur für die -build
Phase einfügen. Statt die vorherige Syntax zu verwenden, geben Sie in einer einzigen Ziele sämtliche Befehle an, die Sie während der Build-Phase verwenden möchten. Bei mehreren Befehlen unterteilen Sie die einzelnen Befehle mit &&
, (wie z. B. mvn test && mvn
package
).
Sie können die - CodeBuild oder - CodePipeline Konsolen anstelle einer buildspec.yml-Datei verwenden, um die Speicherorte der Build-Ausgabeartefakte in der Build-Umgebung anzugeben. Statt die vorherige Syntax zu verwenden, geben Sie in einer einzigen Ziele sämtliche Speicherorte an. Bei mehreren Speicherorten trennen Sie die einzelnen Speicherorte durch ein Komma, (wie z. B. buildspec.yml, target/my-app.jar
).
Beispiel für eine Build-Spezifikation
Hier finden Sie ein Beispiel für eine Datei buildspec.yml.
version: 0.2 env: variables: JAVA_HOME: "/usr/lib/jvm/java-8-openjdk-amd64" parameter-store: LOGIN_PASSWORD: /CodeBuild/dockerLoginPassword phases: install: commands: - echo Entered the install phase... - apt-get update -y - apt-get install -y maven finally: - echo This always runs even if the update or install command fails pre_build: commands: - echo Entered the pre_build phase... - docker login -u User -p $LOGIN_PASSWORD finally: - echo This always runs even if the login command fails build: commands: - echo Entered the build phase... - echo Build started on `date` - mvn install finally: - echo This always runs even if the install command fails post_build: commands: - echo Entered the post_build phase... - echo Build completed on `date` reports: arn:aws:codebuild:your-region:your-aws-account-id:report-group/report-group-name-1: files: - "**/*" base-directory: 'target/tests/reports' discard-paths: no reportGroupCucumberJson: files: - 'cucumber/target/cucumber-tests.xml' discard-paths: yes file-format: CUCUMBERJSON # default is JUNITXML artifacts: files: - target/messageUtil-1.0.jar discard-paths: yes secondary-artifacts: artifact1: files: - target/artifact-1.0.jar discard-paths: yes artifact2: files: - target/artifact-2.0.jar discard-paths: yes cache: paths: - '/root/.m2/**/*'
Hier ist ein Beispiel für die vorangehende Build-Spezifikation, ausgedrückt als einzelne Zeichenfolge, zur Verwendung mit der AWS CLI oder den AWS SDKs .
"version: 0.2\n\nenv:\n variables:\n JAVA_HOME: \"/usr/lib/jvm/java-8-openjdk-amd64\\"\n parameter-store:\n LOGIN_PASSWORD: /CodeBuild/dockerLoginPassword\n phases:\n\n install:\n commands:\n - echo Entered the install phase...\n - apt-get update -y\n - apt-get install -y maven\n finally:\n - echo This always runs even if the update or install command fails \n pre_build:\n commands:\n - echo Entered the pre_build phase...\n - docker login -u User -p $LOGIN_PASSWORD\n finally:\n - echo This always runs even if the login command fails \n build:\n commands:\n - echo Entered the build phase...\n - echo Build started on `date`\n - mvn install\n finally:\n - echo This always runs even if the install command fails\n post_build:\n commands:\n - echo Entered the post_build phase...\n - echo Build completed on `date`\n\n reports:\n reportGroupJunitXml:\n files:\n - \"**/*\"\n base-directory: 'target/tests/reports'\n discard-paths: false\n reportGroupCucumberJson:\n files:\n - 'cucumber/target/cucumber-tests.xml'\n file-format: CUCUMBERJSON\n\nartifacts:\n files:\n - target/messageUtil-1.0.jar\n discard-paths: yes\n secondary-artifacts:\n artifact1:\n files:\n - target/messageUtil-1.0.jar\n discard-paths: yes\n artifact2:\n files:\n - target/messageUtil-1.0.jar\n discard-paths: yes\n cache:\n paths:\n - '/root/.m2/**/*'"
Hier ist ein Beispiel für die Befehle in der -build
Phase zur Verwendung mit der - CodeBuild oder - CodePipeline Konsole.
echo Build started on `date` && mvn install
In diesen Beispielen gilt:
-
Eine benutzerdefinierte Klartext-Umgebungsvariable mit dem Schlüssel
JAVA_HOME
und dem Wert/usr/lib/jvm/java-8-openjdk-amd64
wird eingerichtet. -
Eine benutzerdefinierte Umgebungsvariable mit dem Namen , die
dockerLoginPassword
Sie im Amazon EC2 Systems Manager Parameter Store gespeichert haben, wird später in Build-Befehlen mithilfe des Schlüssels referenziertLOGIN_PASSWORD
. -
Sie können diese Build-Phasennamen nicht ändern. Die in diesem Beispiel ausgeführten Befehle sind
apt-get update -y
undapt-get install -y maven
(zum Installieren von Apache Maven),mvn install
(zum Kompilieren, Testen und Verpacken des Quellcodes in ein Build-Ausgabeartefakt und zum Installieren des Build-Ausgabeartefakts in seinem internen Repository),docker login
(zum Anmelden bei Docker mit dem Passwort, das dem Wert der benutzerdefinierten Umgebungsvariablen entspricht, diedockerLoginPassword
Sie in Amazon EC2 Systems Manager Parameter Store festgelegt haben) und mehrereecho
Befehle. Dieecho
Befehle sind hier enthalten, um zu zeigen, wie Befehle CodeBuild ausführt und in welcher Reihenfolge sie ausgeführt werden. -
files
stellt die Dateien dar, die in den Build-Ausgabespeicherort hochgeladen werden sollen. In diesem Beispiel lädt die einzelne Datei CodeBuild hochmessageUtil-1.0.jar
. Die DateimessageUtil-1.0.jar
ist in dem jeweiligen Verzeichnis mit Namentarget
in der Build-Umgebung zu finden. Dadiscard-paths: yes
angegeben wird, wirdmessageUtil-1.0.jar
direkt hochgeladen (und nicht an ein intermediäres Verzeichnis mit dem Namentarget
). Der DateinamemessageUtil-1.0.jar
und der dazugehörige Verzeichnisname vontarget
basiert auf der Weise, wie - nur für dieses Beispiel - unter den Apache Maven Build-Ausgabeartefakte erstellt und gespeichert werden. In Ihren eigenen Szenarios lauten diese Dateinamen und Verzeichnisse anders. -
reports
stellt zwei Berichtsgruppen dar, die während des Builds Berichte generieren:-
arn:aws:codebuild:your-region:your-aws-account-id:report-group/report-group-name-1
gibt den ARN einer Berichtsgruppe an. Testergebnisse, die vom Test-Framework generiert werden, befinden sich im Verzeichnistarget/tests/reports
. Das Dateiformat istJunitXml
und der Pfad wird nicht aus den Dateien entfernt, die Testergebnisse enthalten. -
reportGroupCucumberJson
gibt eine neue Berichtsgruppe an. Wenn der Name des Projektsmy-project
lautet, wird beim Ausführen eines Builds eine Berichtsgruppe mit dem Namenmy-project-reportGroupCucumberJson
erstellt. Testergebnisse, die vom Test-Framework generiert werden, befinden sich incucumber/target/cucumber-tests.xml
. Das Testdateiformat istCucumberJson
und der Pfad wird aus den Dateien entfernt, die Testergebnisse enthalten.
-
Versionen der Build-Spezifikationen
In der folgenden Tabelle werden Versionen von Build-Spezifikationen und die Änderungen zwischen den Versionen aufgeführt.
Version | Änderungen |
---|---|
0.2 |
|
0.1 | Dies ist die erste Definition des Build-Spezifikationsformats. |