AWS CodeBuild Aktionsreferenz zum Erstellen und Testen - AWS CodePipeline
AktionstypKonfigurationsparameter Input artifacts (Eingabeartefakte)AusgabeartefakteAusgabevariablenAktionsdeklaration (CodeBuild-Beispiel)Weitere Informationen finden Sie auch unter

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.

AWS CodeBuild Aktionsreferenz zum Erstellen und Testen

Ermöglicht die Ausführung von Builds und Tests als Teil Ihrer Pipeline. Wenn Sie eine CodeBuild Build- oder Testaktion ausführen, werden die in der Build-Spezifikation angegebenen Befehle innerhalb eines CodeBuild Containers ausgeführt. Alle Artefakte, die als Eingabeartefakte für eine CodeBuild Aktion angegeben sind, sind innerhalb des Containers verfügbar, in dem die Befehle ausgeführt werden. CodeBuild kann entweder eine Build- oder eine Testaktion bereitstellen. Weitere Informationen finden Sie im AWS CodeBuild -Benutzerhandbuch.

Wenn Sie den CodePipeline Assistenten in der Konsole verwenden, um ein Build-Projekt zu erstellen, zeigt das CodeBuild Build-Projekt den Quellanbieter an CodePipeline. Wenn Sie ein Build-Projekt in der CodeBuild Konsole erstellen, können Sie nicht den Quellanbieter angeben CodePipeline , aber wenn Sie die Build-Aktion zu Ihrer Pipeline hinzufügen, wird die Quelle in der CodeBuild Konsole angepasst. Weitere Informationen finden Sie ProjectSourcein der AWS CodeBuild APIReferenz.

Aktionstyp

  • Kategorie: Build oder Test

  • Eigentümer: AWS

  • Anbieter: CodeBuild

  • Version: 1

Konfigurationsparameter

ProjectName

Erforderlich: Ja

ProjectNameist der Name des Build-Projekts in CodeBuild.

PrimarySource

Required: Conditional

Der Wert des PrimarySource Parameters muss der Name eines der Eingabeartefakte für die Aktion sein. CodeBuild sucht nach der Build-Spezifikationsdatei und führt die Build-Spezifikationsbefehle in dem Verzeichnis aus, das die entpackte Version dieses Artefakts enthält.

Dieser Parameter ist erforderlich, wenn mehrere Eingabeartefakte für eine Aktion angegeben sind. CodeBuild Wenn nur ein Quellartefakt für die Aktion vorhanden ist, verwendet das PrimarySource-Artefakt standardmäßig dieses Artefakt.

BatchEnabled

Erforderlich: Nein

Der boolesche Wert des BatchEnabled Parameters ermöglicht es der Aktion, mehrere Builds in derselben Build-Ausführung auszuführen.

Wenn diese Option aktiviert ist, ist die CombineArtifacts Option verfügbar.

Pipeline-Beispiele mit aktivierten Batch-Builds finden Sie unter CodePipeline Integration mit CodeBuild und Batch-Builds.

CombineArtifacts

Erforderlich: Nein

Der boolesche Wert des CombineArtifacts Parameters kombiniert alle Build-Artefakte aus einem Batch-Build in einer einzigen Artefaktdatei für die Build-Aktion.

Um diese Option verwenden zu können, muss der BatchEnabled Parameter aktiviert sein.

EnvironmentVariables

Erforderlich: Nein

Der Wert dieses Parameters wird verwendet, um Umgebungsvariablen für die CodeBuild Aktion in Ihrer Pipeline festzulegen. Der Wert für den EnvironmentVariables Parameter hat die Form eines JSON Arrays von Umgebungsvariablenobjekten. Einen Beispielparameter finden Sie unter Aktionsdeklaration (CodeBuild-Beispiel).

Jedes Objekt besteht aus drei Teilen. Alle Teile sind Zeichenfolgen:

  • name: Der Name oder Schlüssel der Umgebungsvariable.

  • value: Der Wert der Umgebungsvariable. Wenn Sie den SECRETS_MANAGER Typ PARAMETER_STORE oder verwenden, muss dieser Wert der Name eines Parameters sein, den Sie bereits im AWS Systems Manager Parameter Store gespeichert haben, bzw. eines Secrets, das Sie bereits in AWS Secrets Manager gespeichert haben.

    Anmerkung

    Es wird dringend davon abgeraten, Umgebungsvariablen zum Speichern sensibler Werte, insbesondere von AWS Anmeldeinformationen, zu verwenden. Wenn Sie die CodeBuild Konsole oder verwenden AWS CLI, werden Umgebungsvariablen im Klartext angezeigt. Wenn es sich um vertrauliche Werte handelt, sollten Sie stattdessen den Typ SECRETS_MANAGER verwenden.

  • type: (Optional) Der Typ der Umgebungsvariablen. Gültige Werte sind PARAMETER_STORE, SECRETS_MANAGER oder PLAINTEXT. Wenn keine Angabe gemacht wird, gilt der Standardwert PLAINTEXT.

Anmerkung

Wenn Sie namevalue, und type für Ihre Umgebungsvariablenkonfiguration eingeben, insbesondere wenn die Umgebungsvariable die Syntax der CodePipeline Ausgabevariablen enthält, sollten Sie die 1000-Zeichen-Grenze für das Wertefeld der Konfiguration nicht überschreiten. Ein Validierungsfehler wird zurückgegeben, wenn dieser Grenzwert überschritten wird.

Weitere Informationen finden Sie EnvironmentVariablein der AWS CodeBuild API Referenz. Ein Beispiel für eine CodeBuild Aktion mit einer Umgebungsvariablen, die in den Namen der GitHub Verzweigung aufgelöst wird, finden Sie unterBeispiel: Verwenden Sie eine BranchName Variable mit CodeBuild Umgebungsvariablen.

Input artifacts (Eingabeartefakte)

  • Anzahl der Artefakte: 1 to 5

  • Beschreibung: CodeBuild sucht nach der Build-Spezifikationsdatei und führt die Build-Spezifikationsbefehle aus dem Verzeichnis des primären Quellartefakts aus. Wenn mehr als eine Eingabequelle für die CodeBuild Aktion angegeben wurde, muss dieses Artefakt mithilfe des PrimarySource Aktionskonfigurationsparameters in festgelegt werden. CodePipeline

    Jedes Eingabeartefakt wird in ein eigenes Verzeichnis extrahiert, dessen Speicherorte in Umgebungsvariablen gespeichert sind. Das Verzeichnis für das primäre Quellartefakt wird mit $CODEBUILD_SRC_DIR zur Verfügung gestellt. Die Verzeichnisse für alle anderen Eingabeartefakte werden mit $CODEBUILD_SRC_DIR_yourInputArtifactName zur Verfügung gestellt.

    Anmerkung

    Das in Ihrem CodeBuild Projekt konfigurierte Artefakt wird zum Eingabeartefakt, das von der CodeBuild Aktion in Ihrer Pipeline verwendet wird.

Ausgabeartefakte

  • Anzahl der Artefakte: 0 to 5

  • Beschreibung: Diese können verwendet werden, um die in der CodeBuild Build-Spezifikationsdatei definierten Artefakte für nachfolgende Aktionen in der Pipeline verfügbar zu machen. Wenn nur ein Ausgabeartefakt definiert ist, kann dieses Artefakt direkt im artifacts-Abschnitt der Build-Spezifikationsdatei definiert werden. Wenn mehr als ein Ausgabe-Artefakt angegeben ist, müssen in der Buildspezifikationsdatei alle Artefakte, auf die verwiesen wird, als sekundäre Artefakte definiert werden. Die Namen der Ausgabeartefakte in CodePipeline müssen mit den Artefakt-Identifikatoren in der Build-Spezifikationsdatei übereinstimmen.

    Anmerkung

    Das in Ihrem CodeBuild Projekt konfigurierte Artefakt wird zum CodePipeline Eingabeartefakt in Ihrer Pipeline-Aktion.

    Wenn der CombineArtifacts Parameter für Batch-Builds ausgewählt ist, enthält der Speicherort des Ausgabe-Artefakts die kombinierten Artefakte aus mehreren Builds, die in derselben Ausführung ausgeführt wurden.

Ausgabevariablen

Diese Aktion erzeugt als Variablen alle Umgebungsvariablen, die als Teil des Builds exportiert wurden. Weitere Informationen zum Exportieren von Umgebungsvariablen finden Sie EnvironmentVariableim AWS CodeBuild APIHandbuch.

Weitere Informationen zur Verwendung von CodeBuild Umgebungsvariablen in CodePipeline finden Sie in den Beispielen unterCodeBuild Ausgabevariablen für Aktionen. Eine Liste der Umgebungsvariablen, die Sie verwenden können CodeBuild, finden Sie im AWS CodeBuild Benutzerhandbuch unter Umgebungsvariablen in Build-Umgebungen.

Aktionsdeklaration (CodeBuild-Beispiel)

YAML
Name: Build
Actions:
  - Name: PackageExport
    ActionTypeId:
      Category: Build
      Owner: AWS
      Provider: CodeBuild
      Version: '1'
    RunOrder: 1
    Configuration:
      BatchEnabled: 'true'
      CombineArtifacts: 'true'
      ProjectName: my-build-project
      PrimarySource: MyApplicationSource1
      EnvironmentVariables: '[{"name":"TEST_VARIABLE","value":"TEST_VALUE","type":"PLAINTEXT"},{"name":"ParamStoreTest","value":"PARAMETER_NAME","type":"PARAMETER_STORE"}]'
    OutputArtifacts:
      - Name: MyPipeline-BuildArtifact
    InputArtifacts:
      - Name: MyApplicationSource1
      - Name: MyApplicationSource2
JSON
{
    "Name": "Build",
    "Actions": [
        {
            "Name": "PackageExport",
            "ActionTypeId": {
                "Category": "Build",
                "Owner": "AWS",
                "Provider": "CodeBuild",
                "Version": "1"
            },
            "RunOrder": 1,
            "Configuration": {
                "BatchEnabled": "true",
                "CombineArtifacts": "true",
                "ProjectName": "my-build-project",
                "PrimarySource": "MyApplicationSource1",
                "EnvironmentVariables": "[{\"name\":\"TEST_VARIABLE\",\"value\":\"TEST_VALUE\",\"type\":\"PLAINTEXT\"},{\"name\":\"ParamStoreTest\",\"value\":\"PARAMETER_NAME\",\"type\":\"PARAMETER_STORE\"}]"
            },
            "OutputArtifacts": [
                {
                    "Name": "MyPipeline-BuildArtifact"
                }
            ],
            "InputArtifacts": [
                {
                    "Name": "MyApplicationSource1"
                },
                {
                    "Name": "MyApplicationSource2"
                }
            ]
        }
    ]
}

Die folgenden verwandten Ressourcen bieten Ihnen nützliche Informationen für die Arbeit mit dieser Aktion.