GitHub Aktionen in einen Workflow integrieren

Eine GitHub Aktion ist einer CodeCatalyst Aktion sehr ähnlich, außer dass sie für die Verwendung mit GitHub Workflows entwickelt wurde. Einzelheiten zu GitHub Aktionen finden Sie in der Dokumentation zu GitHub Aktionen.

Sie können GitHub Aktionen zusammen mit systemeigenen CodeCatalyst Aktionen in einem CodeCatalyst Workflow verwenden.

Es gibt zwei Möglichkeiten, einem CodeCatalyst Workflow eine GitHub Aktion hinzuzufügen:

• Sie können die GitHub Aktion aus einer kuratierten Liste in der CodeCatalyst Konsole auswählen. Es sind mehrere beliebte GitHub Aktionen verfügbar. Weitere Informationen finden Sie unter Eine kuratierte Aktion GitHub hinzufügen.

• Wenn die GitHub Aktion, die Sie verwenden möchten, in der CodeCatalyst Konsole nicht verfügbar ist, können Sie sie mithilfe der Aktion GitHub Aktionen hinzufügen.

  Eine GitHub Aktionen-Aktion ist eine CodeCatalyst Aktion, die eine GitHub Aktion umschließt und sie mit CodeCatalyst Workflows kompatibel macht.

  Hier ist ein Beispiel für eine GitHub Actions-Aktion, die die Super-Linter-Action umschließt: GitHub

  Actions:
    GitHubAction:
      Identifier: aws/github-actions-runner@v1
      Configuration:
        Steps:
          - name: Lint Code Base
            uses: github/super-linter@v4
            env:
              VALIDATE_ALL_CODEBASE: "true"
              DEFAULT_BRANCH: main

  Im vorherigen Code umschließt die Aktion CodeCatalyst GitHub Aktionen (identifiziert durchaws/github-actions-runner@v1) die Super-Linter-Action (identifiziert durchgithub/super-linter@v4), sodass sie in einem Workflow funktioniert. CodeCatalyst

  Weitere Informationen finden Sie unter Aktion „GitHub Aktionen“ hinzufügen.

Alle GitHub Aktionen — sowohl kuratierte als auch nicht — müssen in eine GitHub Actions-Aktion () aws/github-actions-runner@v1 eingeschlossen werden, wie im vorherigen Beispiel gezeigt. Der Wrapper ist erforderlich, damit die Aktion ordnungsgemäß funktioniert.

Wie unterscheiden sich GitHub Aktionen von CodeCatalyst Aktionen?

GitHub Aktionen, die innerhalb eines CodeCatalyst Workflows verwendet werden, haben nicht die gleiche Zugriffs- und Integrationsebene mit AWS den CodeCatalyst Funktionen (wie Umgebungen und Probleme) wie CodeCatalyst Aktionen.

Können GitHub Aktionen mit anderen CodeCatalyst Aktionen im Workflow interagieren?

Ja. GitHub Aktionen können beispielsweise Variablen, die von anderen CodeCatalyst Aktionen erzeugt wurden, als Eingabe verwenden und auch Ausgabeparameter und Artefakte gemeinsam mit CodeCatalyst Aktionen verwenden. Weitere Informationen finden Sie unter Exportieren eines GitHub Ausgabeparameters, sodass er von anderen Aktionen verwendet werden kann und Referenzieren eines GitHub Ausgabeparameters.

Welche GitHub Aktionen kann ich verwenden?

Sie können jede GitHub Aktion verwenden, die über die CodeCatalyst Konsole verfügbar ist, und jede GitHub Aktion, die im GitHubMarketplace verfügbar ist. Wenn Sie sich entscheiden, eine GitHub Aktion aus dem Marketplace zu verwenden, beachten Sie die folgenden Einschränkungen.

Einschränkungen von GitHub Aktionen in CodeCatalyst

• GitHub Aktionen können nicht mit dem CodeCatalyst Lambda-Compute-Typ verwendet werden.

• GitHub Aktionen werden auf dem Docker-Image der Laufzeitumgebung vom November 2022 ausgeführt, das ältere Tools enthält. Weitere Informationen über das Image und die Tools finden Sie unter. Docker-Images für die Laufzeitumgebung angeben

• GitHub Aktionen, die intern auf den githubKontext angewiesen sind oder auf GitHub spezifische Ressourcen verweisen, funktionieren nicht in. CodeCatalyst Die folgenden Aktionen funktionieren beispielsweise nicht in CodeCatalyst:

  • Aktionen, die versuchen, GitHub Ressourcen hinzuzufügen, zu ändern oder zu aktualisieren. Beispiele hierfür sind Aktionen, die Pull-Requests aktualisieren oder Probleme in verursachen GitHub.

  • Fast alle Aktionen sind unter https://github.com/actions aufgeführt.

• GitHub Aktionen, bei denen es sich um Docker-Container-Aktionen handelt, funktionieren, müssen jedoch vom Docker-Standardbenutzer (root) ausgeführt werden. Führen Sie die Aktion nicht als Benutzer 1001 aus. (Zum Zeitpunkt des Schreibens arbeitet der Benutzer 1001 in GitHub, aber nicht in CodeCatalyst.) Weitere Informationen finden Sie im Thema USER unter Dockerfile-Unterstützung für GitHub Aktionen.

Eine Liste der GitHub Aktionen, die über die CodeCatalyst Konsole verfügbar sind, finden Sie unter. Eine kuratierte Aktion GitHub hinzufügen

Wie füge ich eine GitHub Aktion hinzu (allgemeine Schritte)?

Die allgemeinen Schritte zum Hinzufügen einer GitHub Aktion zu einem CodeCatalyst Workflow lauten wie folgt:

1. In Ihrem CodeCatalyst Projekt erstellen Sie einen Workflow. In diesem Workflow definieren Sie, wie Ihre Anwendung erstellt, getestet und bereitgestellt werden soll. Weitere Informationen finden Sie unter Erste Schritte mit Workflows.

2. Im Workflow fügen Sie eine kuratierte GitHub Aktion hinzu oder Sie fügen die Aktion GitHub Aktionen hinzu.

3. Sie führen einen der folgenden Schritte aus:

   • Wenn Sie eine kuratierte Aktion hinzufügen möchten, konfigurieren Sie sie. Weitere Informationen finden Sie unter Eine kuratierte Aktion GitHub hinzufügen.

   • Wenn Sie eine nicht kuratierte Aktion hinzufügen möchten, fügen Sie innerhalb der Aktion GitHubAktionen den YAML-Code der GitHub Aktion ein. Du findest diesen Code auf der Detailseite der von dir ausgewählten GitHub Aktion im GitHubMarketplace. Sie müssen den Code wahrscheinlich leicht modifizieren, damit er funktioniert CodeCatalyst. Weitere Informationen finden Sie unter Aktion „GitHub Aktionen“ hinzufügen.

4. (Optional) Innerhalb des Workflows fügen Sie weitere Aktionen wie die Build- und Testaktionen hinzu. Weitere Informationen finden Sie unter Erstellen, Testen und Bereitstellen mit Workflows in CodeCatalyst.

5. Sie starten den Workflow entweder manuell oder automatisch über einen Trigger. Der Workflow führt die GitHub Aktion und alle anderen Aktionen im Workflow aus. Weitere Informationen finden Sie unter Manuelles Starten einer Workflow-Ausführung.

Eine ausführliche Anleitung dazu finden Sie unter:

• Eine kuratierte Aktion GitHub hinzufügen.

• Aktion „GitHub Aktionen“ hinzufügen.

Wird die GitHub Aktion ausgeführt GitHub?

Nein. Die GitHub Aktion läuft unter CodeCatalyst Verwendung CodeCatalyst der Build-Maschinen.

Kann ich auch GitHub Workflows verwenden?

Nein.

Themen

• Tutorial: Lint-Code mit einer GitHub Aktion in einem Workflow
• Aktion „GitHub Aktionen“ hinzufügen
• Eine kuratierte Aktion GitHub hinzufügen
• Exportieren eines GitHub Ausgabeparameters, sodass er von anderen Aktionen verwendet werden kann
• Referenzieren eines GitHub Ausgabeparameters
• YAML-Definition der Aktion „GitHub Aktionen“