Verwenden von benutzerdefinierten Variablen - Amazon CodeCatalyst
Definition einer VariablenEin Geheimnis definieren Eine Variable exportieren, sodass sie von anderen Aktionen verwendet werden kannIn der Aktion, die sie definiert, auf eine Variable verweisenVerweisen auf eine Variable, die von einer anderen Aktion ausgegeben wurdeVerweisen auf ein GeheimnisBeispiele für benutzerdefinierte Variablen

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.

Verwenden von benutzerdefinierten Variablen

Benutzerdefinierte Variablen sind Schlüssel-Wert-Paare, die Sie definieren. Es gibt zwei Typen:

  • Klartext-Variablen oder einfach Variablen — Dies sind Schlüssel-Wert-Paare, die Sie in der Workflow-Definitionsdatei im Klartext definieren.

  • Secrets — Dies sind Schlüssel-Wert-Paare, die Sie auf einer separaten Secrets-Seite der CodeCatalyst Amazon-Konsole definieren. Der Schlüssel (Name) ist ein öffentliches Label, und der Wert enthält die Informationen, die Sie geheim halten möchten. Sie geben nur den Schlüssel in der Workflow-Definitionsdatei an. Verwenden Sie geheime Schlüssel anstelle von Kennwörtern und anderen vertraulichen Informationen in der Workflow-Definitionsdatei.

Anmerkung

Der Kürze halber wird in diesem Leitfaden der Begriff Variable für Klartext-Variable verwendet.

Definition einer Variablen

Sie können Variablen auf zwei Arten definieren:

Beispiele finden Sie unter Beispiele für benutzerdefinierte Variablen.

Visual
Um eine Variable im Abschnitt „Eingaben“ zu definieren (visueller Editor)

  1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

  2. Wählen Sie Ihr Projekt.

  3. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  4. Wählen Sie den Namen Ihres Workflows. Sie können nach dem Quell-Repository oder dem Branch-Namen filtern, in dem der Workflow definiert ist, oder nach dem Workflow-Namen filtern.

  5. Wählen Sie Bearbeiten aus.

  6. Wählen Sie Visual.

  7. Wählen Sie im Workflow-Diagramm die Aktion aus, für die Sie die Variable setzen möchten.

  8. Wählen Sie Eingaben.

  9. Wählen Sie unter Variablen — optional die Option Variable hinzufügen aus, und gehen Sie dann wie folgt vor:

    Geben Sie eine Folge von Name/Wert-Paaren an, die die Eingabevariablen definieren, die Sie für die Aktion verfügbar machen möchten. Variablennamen sind auf alphanumerische Zeichen (a-z, A-Z, 0-9), Bindestriche (-) und Unterstriche (_) beschränkt. Leerzeichen sind nicht erlaubt. Sie können keine Anführungszeichen verwenden, um Sonderzeichen und Leerzeichen in Variablennamen zuzulassen.

    Weitere Informationen zu Variablen, einschließlich Beispielen, finden Sie unterKonfiguration und Verwendung von Variablen in einem Workflow.

  10. (Optional) Wählen Sie „Validieren“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.

  11. Wählen Sie Commit, geben Sie eine Commit-Nachricht ein und wählen Sie erneut Commit aus.

YAML
Um eine Variable im Abschnitt „Eingaben“ zu definieren (YAML-Editor)

  1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

  2. Wählen Sie Ihr Projekt.

  3. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  4. Wählen Sie den Namen Ihres Workflows. Sie können nach dem Quell-Repository oder dem Branch-Namen filtern, in dem der Workflow definiert ist, oder nach dem Workflow-Namen filtern.

  5. Wählen Sie Bearbeiten aus.

  6. Wählen Sie YAML.

  7. Fügen Sie in einer Workflow-Aktion Code hinzu, der dem folgenden ähnelt:

    action-name:
  Inputs:
    Variables:
      - Name: variable-name
        Value: variable-value

    Weitere Beispiele finden Sie unter Beispiele für benutzerdefinierte Variablen. Weitere Informationen finden Sie unter YAML-Workflow-Definition Für Ihre Aktion.

  8. (Optional) Wählen Sie „Validieren“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.

  9. Wählen Sie Commit, geben Sie eine Commit-Nachricht ein und wählen Sie erneut Commit aus.
Visual
Um eine Variable im Abschnitt „Schritte“ zu definieren (visueller Editor)

  1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

  2. Wählen Sie Ihr Projekt.

  3. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  4. Wählen Sie den Namen Ihres Workflows. Sie können nach dem Quell-Repository oder dem Branch-Namen filtern, in dem der Workflow definiert ist, oder nach dem Workflow-Namen filtern.

  5. Wählen Sie Bearbeiten aus.

  6. Wählen Sie Visual.

  7. Wählen Sie im Workflow-Diagramm die Aktion aus, für die Sie die Variable setzen möchten.

  8. Wählen Sie Konfiguration.

  9. Definieren Sie in Shell-Befehlen oder GitHubActions YAML, je nachdem, was verfügbar ist, eine Variable in den AktionenSteps, entweder explizit oder implizit.

    • Um die Variable explizit zu definieren, fügen Sie sie in einen Bash-Befehl direkt in den Abschnitt ein. Steps

    • Um eine Variable implizit zu definieren, geben Sie sie in einer Datei an, auf die im Abschnitt der Aktion verwiesen wird. Steps

      Beispiele finden Sie unter Beispiele für benutzerdefinierte Variablen. Weitere Informationen finden Sie unter YAML-Workflow-Definition Für die Aktion.

  10. (Optional) Wählen Sie „Validieren“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.

  11. Wählen Sie Commit, geben Sie eine Commit-Nachricht ein und wählen Sie erneut Commit aus.

YAML
Um eine Variable im Abschnitt „Schritte“ zu definieren (YAML-Editor)

  1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

  2. Wählen Sie Ihr Projekt.

  3. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  4. Wählen Sie den Namen Ihres Workflows. Sie können nach dem Quell-Repository oder dem Branch-Namen filtern, in dem der Workflow definiert ist, oder nach dem Workflow-Namen filtern.

  5. Wählen Sie Bearbeiten aus.

  6. Wählen Sie YAML.

  7. Definieren Sie in einer Workflow-Aktion eine Variable im Steps Abschnitt der Aktion, entweder explizit oder implizit.

    • Um die Variable explizit zu definieren, fügen Sie sie in einen Bash-Befehl direkt in den Steps Abschnitt ein.

    • Um eine Variable implizit zu definieren, geben Sie sie in einer Datei an, auf die im Abschnitt der Aktion verwiesen wird. Steps

      Beispiele finden Sie unter Beispiele für benutzerdefinierte Variablen. Weitere Informationen finden Sie unter YAML-Workflow-Definition Für die Aktion.

  8. (Optional) Wählen Sie „Validieren“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.

  9. Wählen Sie Commit, geben Sie eine Commit-Nachricht ein und wählen Sie erneut Commit aus.

Ein Geheimnis definieren

Sie definieren ein Geheimnis auf der Seite Secrets der CodeCatalyst Konsole. Weitere Informationen finden Sie unter Konfiguration und Verwendung von Geheimnissen in einem Workflow.

Sie könnten beispielsweise ein Geheimnis definieren, das wie folgt aussieht:

  • Name (Schlüssel): my-password

  • Wert: ^*H3#!b9

Nachdem das Geheimnis definiert wurde, können Sie den Schlüssel (my-password) des Geheimnisses in der Workflow-Definitionsdatei angeben. Ein Beispiel für diese Vorgehensweise finden Sie unter Beispiel: Verweisen auf ein Geheimnis.

Eine Variable exportieren, sodass sie von anderen Aktionen verwendet werden kann

Verwenden Sie die folgenden Anweisungen, um eine Variable aus einer Aktion zu exportieren, sodass Sie in anderen Aktionen darauf verweisen können.

Bevor Sie eine Variable exportieren, beachten Sie Folgendes:

  • Wenn Sie nur innerhalb der Aktion, in der sie definiert ist, auf die Variable verweisen müssen, müssen Sie sie nicht exportieren.

  • Nicht alle Aktionen unterstützen den Export von Variablen. Um festzustellen, ob Ihre Aktion diese Funktion unterstützt, führen Sie die folgenden Anweisungen für den visuellen Editor durch und prüfen Sie, ob die Aktion auf der Registerkarte Ausgaben eine Schaltfläche „Variablen“ enthält. Falls ja, wird der Export von Variablen unterstützt.

  • Informationen zum Exportieren einer Variablen aus einer GitHub Aktion finden Sie unterExportieren eines GitHub Ausgabeparameters, sodass er von anderen Aktionen verwendet werden kann.

Voraussetzung

Stellen Sie sicher, dass Sie die Variable definiert haben, die Sie exportieren möchten. Weitere Informationen finden Sie unter Definition einer Variablen.

Visual
Um eine Variable zu exportieren (visueller Editor)

  1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

  2. Wählen Sie Ihr Projekt.

  3. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  4. Wählen Sie den Namen Ihres Workflows. Sie können nach dem Quell-Repository oder dem Branch-Namen filtern, in dem der Workflow definiert ist, oder nach dem Workflow-Namen filtern.

  5. Wählen Sie Bearbeiten aus.

  6. Wählen Sie Visual.

  7. Wählen Sie im Workflow-Diagramm die Aktion aus, aus der Sie die Variable exportieren möchten.

  8. Wählen Sie Ausgaben aus.

  9. Wählen Sie unter Variablen — optional die Option Variable hinzufügen aus, und gehen Sie dann wie folgt vor:

    Geben Sie den Namen einer Variablen an, die die Aktion exportieren soll. Diese Variable muss bereits im Steps Abschnitt Inputs oder derselben Aktion definiert sein.

  10. (Optional) Wählen Sie „Validieren“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.

  11. Wählen Sie Commit, geben Sie eine Commit-Nachricht ein und wählen Sie erneut Commit aus.

YAML
Um eine Variable zu exportieren (YAML-Editor)

  1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

  2. Wählen Sie Ihr Projekt.

  3. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  4. Wählen Sie den Namen Ihres Workflows. Sie können nach dem Quell-Repository oder dem Branch-Namen filtern, in dem der Workflow definiert ist, oder nach dem Workflow-Namen filtern.

  5. Wählen Sie Bearbeiten aus.

  6. Wählen Sie YAML.

  7. Fügen Sie in der Aktion, aus der Sie die Variable exportieren möchten, Code hinzu, der dem folgenden ähnelt:

    action-name:
  Outputs:
    Variables:
      - Name: variable-name

    Weitere Beispiele finden Sie unter Beispiele für benutzerdefinierte Variablen.

  8. (Optional) Wählen Sie „Validieren“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.

  9. Wählen Sie Commit, geben Sie eine Commit-Nachricht ein und wählen Sie erneut Commit aus.

In der Aktion, die sie definiert, auf eine Variable verweisen

Verwenden Sie die folgenden Anweisungen, um in der Aktion, die sie definiert, auf eine Variable zu verweisen.

Anmerkung

Informationen zum Verweisen auf eine durch eine GitHub Aktion generierte Variable finden Sie unterReferenzieren eines GitHub Ausgabeparameters.

Voraussetzung

Stellen Sie sicher, dass Sie die Variable definiert haben, auf die Sie verweisen möchten. Weitere Informationen finden Sie unter Definition einer Variablen.

Visual

Nicht verfügbar. Wählen Sie YAML, um die YAML-Anweisungen anzuzeigen.

YAML
Um in der Aktion, die sie definiert, auf eine Variable zu verweisen

  1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

  2. Wählen Sie Ihr Projekt.

  3. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  4. Wählen Sie den Namen Ihres Workflows. Sie können nach dem Quell-Repository oder dem Branch-Namen filtern, in dem der Workflow definiert ist, oder nach dem Workflow-Namen filtern.

  5. Wählen Sie Bearbeiten aus.

  6. Wählen Sie YAML.

  7. Fügen Sie in der CodeCatalyst Aktion, die die Variable definiert, auf die Sie verweisen möchten, die Variable mit der folgenden Bash-Syntax hinzu:

    $variable-name

    Beispielsweise:

    MyAction:
    Configuration:
      Steps:
        - Run: $variable-name

    Weitere Beispiele finden Sie unter Beispiele für benutzerdefinierte Variablen. Weitere Informationen finden Sie in den Referenzinformationen für Ihre Aktion imYAML-Workflow-Definition.

  8. (Optional) Wählen Sie „Validieren“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.

  9. Wählen Sie Commit, geben Sie eine Commit-Nachricht ein und wählen Sie erneut Commit.

Verweisen auf eine Variable, die von einer anderen Aktion ausgegeben wurde

Verwenden Sie die folgenden Anweisungen, um auf Variablen zu verweisen, die von anderen Aktionen ausgegeben wurden.

Anmerkung

Informationen zum Verweisen auf eine Variablenausgabe aus einer GitHub Aktion finden Sie unterReferenzieren eines GitHub Ausgabeparameters.

Voraussetzung

Stellen Sie sicher, dass Sie die Variable exportiert haben, auf die Sie verweisen möchten. Weitere Informationen finden Sie unter Eine Variable exportieren, sodass sie von anderen Aktionen verwendet werden kann.

Visual

Nicht verfügbar. Wählen Sie YAML, um die YAML-Anweisungen anzuzeigen.

YAML
Um auf eine Variable zu verweisen, die von einer anderen Aktion ausgegeben wurde (YAML-Editor)

  1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

  2. Wählen Sie Ihr Projekt.

  3. Wählen Sie im Navigationsbereich CI/CD und dann Workflows aus.

  4. Wählen Sie den Namen Ihres Workflows. Sie können nach dem Quell-Repository oder dem Branch-Namen filtern, in dem der Workflow definiert ist, oder nach dem Workflow-Namen filtern.

  5. Wählen Sie Bearbeiten aus.

  6. Wählen Sie YAML.

  7. Fügen Sie in der CodeCatalyst Aktion mithilfe der folgenden Syntax einen Verweis auf die Variable hinzu:

    ${action-group-name.action-name.variable-name}

    Ersetze:

    • action-group-namemit dem Namen der Aktionsgruppe, die die Aktion enthält, die eine Variable ausgibt.

      Anmerkung

      Sie können weglassen, action-group-namewenn es keine Aktionsgruppe gibt oder wenn die Variable durch eine Aktion in derselben Aktionsgruppe erzeugt wird.

    • Aktionsname mit dem Namen der Aktion, die die Variable ausgibt.

    • Variablenname mit dem Namen der Variablen.

    Beispielsweise:

    MySecondAction:
    Configuration:
      Steps:
        - Run: ${MyFirstAction.TIMESTAMP}

    Weitere Beispiele finden Sie unter Beispiele für benutzerdefinierte Variablen. Weitere Informationen finden Sie unter YAML-Workflow-Definition Für Ihre Aktion.

  8. (Optional) Wählen Sie „Validieren“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.

  9. Wählen Sie Commit, geben Sie eine Commit-Nachricht ein und wählen Sie erneut Commit.

Verweisen auf ein Geheimnis

Anweisungen zum Verweisen auf ein Geheimnis in der Workflow-Definitionsdatei finden Sie unter. Ein Geheimnis verwenden

Ein Beispiel finden Sie unter Beispiel: Verweisen auf ein Geheimnis.

Beispiele für benutzerdefinierte Variablen

Die folgenden Beispiele zeigen, wie Variablen in der Workflow-Definitionsdatei definiert und referenziert werden.

Beispiel: Definition einer Variablen mithilfe der Eigenschaft Inputs

Das folgende Beispiel zeigt Ihnen, wie Sie zwei Variablen definieren, VAR1 undVAR2, in einem Inputs Abschnitt.

Actions:
  Build:
    Identifier: aws/build@v1
    Inputs:
      Variables:
      - Name: VAR1
        Value: "My variable 1"
      - Name: VAR2
        Value: "My variable 2"

Beispiel: Definieren einer Variablen mithilfe der Eigenschaft Steps

Das folgende Beispiel zeigt Ihnen, wie Sie eine DATE Variable in dem Steps Abschnitt explizit definieren.

Actions:
  Build:
    Identifier: aws/build@v1
    Configuration:    
      Steps:
        - Run: DATE=$(date +%m-%d-%y)

Beispiel: Exportieren einer Variablen mithilfe der Outputs-Eigenschaft

Das folgende Beispiel zeigt Ihnen, wie Sie zwei Variablen definieren REPOSITORY-URI und TIMESTAMP diese mithilfe des Outputs Abschnitts exportieren.

Actions:
  Build:
    Identifier: aws/build@v1
    Inputs:
      Variables:
        - Name: REPOSITORY-URI
          Value: 111122223333.dkr.ecr.us-east-2.amazonaws.com/codecatalyst-ecs-image-repo
    Configuration:
      Steps:
        - Run: TIMESTAMP=$(date +%m-%d-%y-%H-%m-%s) 
    Outputs:
      Variables:
        - REPOSITORY-URI
        - TIMESTAMP

Beispiel: Verweisen auf eine Variable, die in derselben Aktion definiert wurde

Das folgende Beispiel zeigt IhnenMyBuildAction, wie Sie eine VAR1 Variable in angeben und dann in derselben Aktion darauf verweisen, indem Sie$VAR1.

Actions:
  MyBuildAction:
    Identifier: aws/build@v1
    Inputs:
      Variables:
        - Name: VAR1
          Value: my-value
    Configuration:
      Steps:
        - Run: $VAR1

Beispiel: Verweisen auf eine Variable, die in einer anderen Aktion definiert wurde

Das folgende Beispiel zeigt, wie Sie eine TIMESTAMP Variable in angebenBuildActionA, sie mithilfe der Outputs Eigenschaft exportieren und dann in BuildActionB using ${BuildActionA.TIMESTAMP} darauf verweisen.

Actions:
  BuildActionA:
    Identifier: aws/build@v1
    Configuration:    
      Steps:
        - Run: TIMESTAMP=$(date +%m-%d-%y-%H-%m-%s) 
    Outputs:
      Variables:
        - TIMESTAMP
  BuildActionB:
    Identifier: aws/build@v1
    Configuration:
      Steps:
        - Run: docker build -t my-ecr-repo/image-repo:latest .      
        - Run: docker tag my-ecr-repo/image-repo:${BuildActionA.TIMESTAMP}
        
        # Specifying just '$TIMESTAMP' here will not work 
        # because TIMESTAMP is not a variable 
        # in the BuildActionB action.

Beispiel: Verweisen auf ein Geheimnis

Das folgende Beispiel zeigt Ihnen, wie Sie auf ein my-password Geheimnis verweisen. Das my-password ist der Schlüssel des Geheimnisses. Der Schlüssel dieses Geheimnisses und der entsprechende Kennwortwert müssen auf der Seite Geheimnisse der CodeCatalyst Konsole angegeben werden, bevor sie in der Workflow-Definitionsdatei verwendet werden können. Weitere Informationen finden Sie unter Konfiguration und Verwendung von Geheimnissen in einem Workflow.

Actions:
  BuildActionA:
    Identifier: aws/build@v1
    Configuration:    
      Steps:
        - Run: curl -u LiJuan:${Secrets.my-password} https://example.com