Eine kuratierte Aktion GitHub hinzufügen

Eine kuratierte GitHub Aktion ist eine GitHub Aktion, die in der CodeCatalyst Konsole verfügbar gemacht wird und als Beispiel für die Verwendung einer GitHub Aktion in einem CodeCatalyst Workflow dient.

Kuratierte GitHub Aktionen sind in der Aktion „ CodeCatalyst-authored GitHub Actions“ zusammengefasst, die durch die ID identifiziert wird. aws/github-actions-runner@v1 Die kuratierte GitHub Aktion OSS sieht zum Beispiel wie folgt aus: TruffleHog

Actions:
  TruffleHogOSS_e8:
    Identifier: aws/github-actions-runner@v1
    Inputs:
      Sources:
        - WorkflowSource # This specifies that the action requires this Workflow as a source
    Configuration:
      Steps:
        - uses: trufflesecurity/trufflehog@v3.16.0
          with:
            path: ' ' # Required; description: Repository path
            base: ' ' # Required; description: Start scanning from here (usually main branch).
            head: ' ' # Optional; description: Scan commits until here (usually dev branch).
            extra_args: ' ' # Optional; description: Extra args to be passed to the trufflehog cli.

Im vorherigen Code umschließt die Aktion CodeCatalyst GitHub Aktionen (identifiziert durchaws/github-actions-runner@v1) die TruffleHog OSS-Aktion (identifiziert durchtrufflesecurity/trufflehog@v3.16.0), sodass sie in einem CodeCatalyst Workflow funktioniert.

Um diese Aktion zu konfigurieren, würden Sie die leeren Zeichenfolgen unter with: durch Ihre eigenen Werte ersetzen. Beispiele:

Actions:
  TruffleHogOSS_e8:
    Identifier: aws/github-actions-runner@v1
    Inputs:
      Sources:
        - WorkflowSource # This specifies that the action requires this Workflow as a source
    Configuration:
      Steps:
        - uses: trufflesecurity/trufflehog@v3.16.0
          with:
            path: ./
            base: main # Required; description: Start scanning from here (usually main branch).
            head: HEAD # Optional; description: Scan commits until here (usually dev branch).
            extra_args: '‐‐debug ‐‐only-verified' # Optional; description: Extra args to be passed to the trufflehog cli.

Gehen Sie wie folgt vor, um einem Workflow eine kuratierte GitHub Aktion hinzuzufügen. Allgemeine Informationen zur Verwendung von GitHub Aktionen in einem CodeCatalyst Workflow finden Sie unter GitHub Aktionen in einen Workflow integrieren.

Anmerkung

Wenn Sie Ihre GitHub Aktion nicht in der Liste der kuratierten Aktionen sehen, können Sie sie trotzdem mit der Aktion GitHub Aktionen zu Ihrem Workflow hinzufügen. Weitere Informationen finden Sie unter Aktion „GitHub Aktionen“ hinzufügen.

Visual

Um eine kuratierte GitHub Aktion mit dem visuellen Editor hinzuzufügen

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 Edit (Bearbeiten) aus.

6. Wählen Sie Visual.

7. Wählen Sie oben links + Aktionen, um den Aktionskatalog zu öffnen.

8. Wählen Sie in der Drop-down-Liste die Option GitHub.

9. Suchen oder suchen Sie nach einer GitHub Aktion und führen Sie einen der folgenden Schritte aus:

   • Wählen Sie das Pluszeichen (+), um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.

     Or

   • Wählen Sie den Namen der GitHub Aktion. Das Dialogfeld mit den Aktionsdetails wird angezeigt. In diesem Dialogfeld gehen Sie wie folgt vor:

     • (Optional) Wählen Sie „Quelltext anzeigen“, um den Quellcode der Aktion anzuzeigen.

     • Wählen Sie Zum Workflow hinzufügen, um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.

10. Füllen Sie auf den Registerkarten Eingaben, Konfiguration und Ausgaben die Felder nach Ihren Bedürfnissen aus. Eine Beschreibung der einzelnen Felder finden Sie unterYAML-Definition der Aktion „GitHub Aktionen“. Diese Referenz enthält detaillierte Informationen zu jedem Feld (und dem entsprechenden YAML-Eigenschaftswert), das für die Aktion GitHubAktionen verfügbar ist, da es sowohl im YAML- als auch im visuellen Editor angezeigt wird.

    Informationen zu den Konfigurationsoptionen, die für die kuratierte GitHub Aktion verfügbar sind, finden Sie in der zugehörigen Dokumentation.

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

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

YAML

Um eine kuratierte GitHub Aktion mit dem YAML-Editor hinzuzufügen

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 Edit (Bearbeiten) aus.

6. Wählen Sie YAML.

7. Wählen Sie links oben + Aktionen aus, um den Aktionskatalog zu öffnen.

8. Wählen Sie in der Drop-down-Liste die Option GitHub.

9. Suchen oder suchen Sie nach einer GitHub Aktion und führen Sie einen der folgenden Schritte aus:

   • Wählen Sie das Pluszeichen (+), um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.

     Or

   • Wählen Sie den Namen der GitHub Aktion. Das Dialogfeld mit den Aktionsdetails wird angezeigt. In diesem Dialogfeld gehen Sie wie folgt vor:

     • (Optional) Wählen Sie „Quelltext anzeigen“, um den Quellcode der Aktion anzuzeigen.

     • Wählen Sie Zum Workflow hinzufügen, um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.

10. Ändern Sie die Eigenschaften im YAML-Code nach Ihren Bedürfnissen. Eine Erläuterung der einzelnen Eigenschaften, die für die Aktion GitHub Aktionen verfügbar sind, finden Sie in. YAML-Definition der Aktion „GitHub Aktionen“

    Informationen zu den Konfigurationsoptionen, die für die kuratierte GitHub Aktion verfügbar sind, finden Sie in der zugehörigen Dokumentation.

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

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