Amazon CodeCatalyst ist nicht mehr offen für Neukunden. Bestandskunden können den Service weiterhin wie gewohnt nutzen. Weitere Informationen finden Sie unter [Wie migriert man von CodeCatalyst](migration.md).
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.
# Integration mit GitHub Aktionen
Eine *GitHub Aktion* ist einer [CodeCatalyst Aktion](workflows-actions.md#workflows-actions-types-cc) 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](https://docs.github.com/en/actions).
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](integrations-github-action-add-curated.md).
+ 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:](https://github.com/marketplace/actions/super-linter) 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 durch`aws/github-actions-runner@v1`) die Super-Linter-Aktion (identifiziert durch`github/super-linter@v4`), sodass sie in einem Workflow funktioniert. CodeCatalyst
Weitere Informationen finden Sie unter [Aktion „GitHub Aktionen“ hinzufügen](integrations-github-action-add.md).
Alle GitHub Aktionen — sowohl kuratierte als auch nicht — müssen in eine **GitHub Aktionsaktion** () `aws/github-actions-runner@v1` eingeschlossen werden, wie im vorherigen Beispiel gezeigt. Der Wrapper ist erforderlich, damit die Aktion ordnungsgemäß funktioniert.
**Topics**
+ [Wie unterscheiden sich GitHub Aktionen von CodeCatalyst Aktionen?](#integrations-github-actions-how-different)
+ [Können GitHub Aktionen mit anderen CodeCatalyst Aktionen im Workflow interagieren?](#integrations-github-actions-interactions.title)
+ [Welche GitHub Aktionen kann ich verwenden?](#integrations-github-actions-supported)
+ [Einschränkungen von GitHub Aktionen in CodeCatalyst](#integrations-github-actions-limitations)
+ [Wie füge ich eine GitHub Aktion hinzu (allgemeine Schritte)?](#integrations-github-actions-how-to)
+ [Wird die GitHub Aktion ausgeführt GitHub?](#integrations-github-actions-where-it-runs)
+ [Kann ich auch GitHub Workflows verwenden?](#integrations-github-actions-workflows-support.title)
+ [Von der Aktion „GitHub Aktionen“ verwendetes Runtime-Image](#integrations-github-actions-runtime)
+ [Tutorial: Lint-Code mit einer GitHub Aktion](integrations-github-action-tutorial.md)
+ [Aktion „GitHub Aktionen“ hinzufügen](integrations-github-action-add.md)
+ [Eine kuratierte Aktion GitHub hinzufügen](integrations-github-action-add-curated.md)
+ [GitHub Ausgabeparameter exportieren](integrations-github-action-export.md)
+ [Referenzieren von GitHub Ausgabeparametern](integrations-github-action-referencing.md)
+ [Aktion 'GitHub Aktionen' YAML](github-action-ref.md)
## 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](deploy-environments.md) und [Probleme](issues.md)) 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 erhalten Sie unter [GitHub Ausgabeparameter exportieren](integrations-github-action-export.md) und [Referenzieren von GitHub Ausgabeparametern](integrations-github-action-referencing.md).
## 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](https://github.com/marketplace/actions) verfügbar ist. Wenn Sie sich für eine GitHub Aktion aus dem Marketplace entscheiden, beachten Sie die folgenden [Einschränkungen](#integrations-github-actions-limitations).
## Einschränkungen von GitHub Aktionen in CodeCatalyst
+ GitHub Aktionen können nicht mit dem CodeCatalyst [Lambda-Compute-Typ](workflows-working-compute.md#compute.types) verwendet werden.
+ GitHub Aktionen werden auf dem Docker-Image der Laufzeitumgebung [vom November 2022](build-images.md#build.previous-image) ausgeführt, das ältere Tools enthält. Weitere Informationen über das Image und die Tools finden Sie unter. [Angabe von Images für die Laufzeitumgebung](build-images.md)
+ GitHub Aktionen, die intern auf den [`github`Kontext](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context) 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 in [https://github.com/actions](https://github.com/actions) aufgeführt.
+ GitHub Aktionen, bei denen es sich um [Docker-Container-Aktionen](https://docs.github.com/en/actions/creating-actions/about-custom-actions#docker-container-actions) 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](https://docs.github.com/en/actions/creating-actions/dockerfile-support-for-github-actions#user) unter [Dockerfile-Unterstützung für GitHub Aktionen](https://docs.github.com/en/actions/creating-actions/dockerfile-support-for-github-actions).
Eine Liste der über die CodeCatalyst Konsole verfügbaren GitHub Aktionen finden Sie unter. [Eine kuratierte Aktion GitHub hinzufügen](integrations-github-action-add-curated.md)
## 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](workflows-getting-started.md).
1. Im Workflow **fügen Sie eine kuratierte GitHub Aktion** hinzu oder Sie **fügen die Aktion GitHub Aktionen** hinzu.
1. 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](integrations-github-action-add-curated.md).
+ 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 deiner ausgewählten GitHub Aktion im [GitHubMarketplace](https://github.com/marketplace/actions). Sie müssen den Code wahrscheinlich leicht modifizieren, damit er funktioniert CodeCatalyst. Weitere Informationen finden Sie unter [Aktion „GitHub Aktionen“ hinzufügen](integrations-github-action-add.md).
1. (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 WorkflowsMit Workflows erstellen, testen und bereitstellen](workflow.md).
1. 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](workflows-manually-start.md).
Eine ausführliche Anleitung finden Sie unter:
+ [Eine kuratierte Aktion GitHub hinzufügen](integrations-github-action-add-curated.md).
+ [Aktion „GitHub Aktionen“ hinzufügen](integrations-github-action-add.md).
## Wird die GitHub Aktion ausgeführt GitHub?
Nein. Die GitHub Aktion wird unter Verwendung CodeCatalyst des [Laufzeitumgebungsabbilds](workflows-working-compute.md) ausgeführt. CodeCatalyst
## Kann ich auch GitHub Workflows verwenden?
Nein.
## Von der Aktion „GitHub Aktionen“ verwendetes Runtime-Image
Die Aktion CodeCatalyst **GitHub Aktionen** wird auf einem [Image vom November 2022](build-images.md#build.previous-image) ausgeführt. Weitere Informationen finden Sie unter [Aktive Bilder](build-images.md#build-curated-images).
# Tutorial: Lint-Code mit einer GitHub Aktion
In diesem Tutorial fügen Sie die [ GitHub Super-Linter-Aktion](https://github.com/marketplace/actions/super-linter) zu einem CodeCatalyst Amazon-Workflow hinzu. Die Super-Linter-Aktion untersucht den Code, findet Bereiche, in denen der Code Fehler, Formatierungsprobleme und verdächtige Konstrukte aufweist, und gibt die Ergebnisse dann an die Konsole aus). CodeCatalyst Nachdem Sie den Linter zu Ihrem Workflow hinzugefügt haben, führen Sie den Workflow aus, um eine Node.js -Beispielanwendung () zu linten. `app.js` Anschließend beheben Sie die gemeldeten Probleme und führen den Workflow erneut aus, um zu überprüfen, ob die Korrekturen erfolgreich waren.
**Tipp**
[Erwägen Sie, Super-Linter zu verwenden, um YAML-Dateien wie Vorlagen zu verlinken.CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-guide.html)
**Topics**
+ [Voraussetzungen](#integrations-github-action-tutorial-prereqs)
+ [Schritt 1: Erstellen Sie ein Quell-Repository](#integrations-github-action-tutorial-create-source-repo)
+ [Schritt 2: Fügen Sie eine Datei app.js hinzu](#integrations-github-action-tutorial-add-appjs)
+ [Schritt 3: Erstellen Sie einen Workflow, der die Super-Linter-Aktion ausführt](#integrations-github-action-tutorial-create-workflow)
+ [Schritt 4: Probleme beheben, die der Super-Linter gefunden hat](#integrations-github-action-tutorial-fix-probs)
+ [Bereinigen](#integrations-github-action-tutorial-cleanup)
## Voraussetzungen
Bevor Sie beginnen, benötigen Sie:
+ Ein CodeCatalyst **Leerzeichen** mit einem verbundenen AWS-Konto. Weitere Informationen finden Sie unter [Erstellen einer Umgebung](spaces-create.md).
+ Ein leeres Projekt in Ihrem CodeCatalyst Bereich namens`codecatalyst-linter-project`. Wählen Sie die Option **Von vorne beginnen**, um dieses Projekt zu erstellen.
```
```
Weitere Informationen finden Sie unter [Ein leeres Projekt in Amazon erstellen CodeCatalyst](projects-create.md#projects-create-empty).
## Schritt 1: Erstellen Sie ein Quell-Repository
In diesem Schritt erstellen Sie ein Quell-Repository in CodeCatalyst. In diesem Repository speichern Sie die Quelldatei der Beispielanwendung für dieses Tutorial. `app.js`
Weitere Informationen zu Quell-Repositorys finden Sie unter[Erstellen eines Quell-Repositorys](source-repositories-create.md).
**Um ein Quell-Repository zu erstellen**
1. Öffnen Sie die CodeCatalyst Konsole unter [https://codecatalyst.aws/](https://codecatalyst.aws/).
1. Navigieren Sie zu Ihrem Projekt,`codecatalyst-linter-project`.
1. Wählen Sie im Navigationsbereich **Code** und dann **Source Repositories** aus.
1. Wählen **Sie Repository hinzufügen** und anschließend **Repository erstellen** aus.
1. Geben Sie im Feld **Repository-Name** Folgendes ein:
```
codecatalyst-linter-source-repository
```
1. Wählen Sie **Erstellen** aus.
## Schritt 2: Fügen Sie eine Datei app.js hinzu
In diesem Schritt fügen Sie Ihrem Quell-Repository eine `app.js` Datei hinzu. Der `app.js` enthält Funktionscode, der einige Fehler enthält, die der Linter finden wird.
**Um die Datei app.js hinzuzufügen**
1. Wählen Sie in der CodeCatalyst Konsole Ihr Projekt aus,`codecatalyst-linter-project`.
1. Wählen Sie im Navigationsbereich **Code** und dann **Source Repositories** aus.
1. Wählen Sie aus der Liste der Quell-Repositorys Ihr Repository aus. `codecatalyst-linter-source-repository`
1. Wählen Sie unter **Dateien** die Option **Datei erstellen** aus.
1. Geben Sie in das Textfeld den folgenden Code ein:
```
// const axios = require('axios')
// const url = 'http://checkip.amazonaws.com/';
let response;
/**
*
* Event doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
* @param {Object} event - API Gateway Lambda Proxy Input Format
*
* Context doc: https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-context.html
* @param {Object} context
*
* Return doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html
* @returns {Object} object - API Gateway Lambda Proxy Output Format
*
*/
exports.lambdaHandler = async (event, context) => {
try {
// const ret = await axios(url);
response = {
statusCode: 200,
'body': JSON.stringify({
message: 'hello world'
// location: ret.data.trim()
})
}
} catch (err) {
console.log(err)
return err
}
return response
}
```
1. Geben Sie als **Dateiname** ein`app.js`. Behalten Sie die anderen Standardoptionen bei.
1. Wählen Sie **Commit** (Übergeben).
Sie haben jetzt eine Datei mit dem Namen erstellt`app.js`.
## Schritt 3: Erstellen Sie einen Workflow, der die Super-Linter-Aktion ausführt
In diesem Schritt erstellen Sie einen Workflow, der die Super-Linter-Aktion ausführt, wenn Sie Code in Ihr Quell-Repository übertragen. Der Workflow besteht aus den folgenden Bausteinen, die Sie in einer YAML-Datei definieren:
+ **Ein Trigger** — Dieser Trigger startet die Workflow-Ausführung automatisch, wenn Sie eine Änderung an Ihr Quell-Repository übertragen. Weitere Informationen zu Auslösern finden Sie unter [Automatisches Starten einer Workflow-Ausführung mithilfe von Triggern](workflows-add-trigger.md).
+ **Eine Aktion „GitHub Aktionen“ — Beim** Auslösen führt die Aktion **GitHub Aktionen** die Super-Linter-Aktion aus, die wiederum alle Dateien in Ihrem Quell-Repository überprüft. Findet der Linter ein Problem, schlägt die Workflow-Aktion fehl.
**Um einen Workflow zu erstellen, der die Super-Linter-Aktion ausführt**
1. Wählen Sie in der CodeCatalyst Konsole Ihr Projekt aus,. `codecatalyst-linter-project`
1. **Wählen Sie im Navigationsbereich **CI/CD** und dann Workflows aus.**
1. Wählen Sie Workflow **erstellen** aus.
1. Wählen Sie für **Quell-Repository** die Option`codecatalyst-linter-source-repository`.
1. Wählen Sie für **Branch** die Option`main`.
1. Wählen Sie **Erstellen** aus.
1. Löschen Sie den YAML-Beispielcode.
1. Fügen Sie das folgende YAML hinzu:
```
Name: codecatalyst-linter-workflow
SchemaVersion: "1.0"
Triggers:
- Type: PUSH
Branches:
- main
Actions:
SuperLinterAction:
Identifier: aws/github-actions-runner@v1
Configuration:
Steps:
github-action-code
```
Ersetzen Sie den Code im vorherigen Code *github-action-code* durch den Super-Linter-Aktionscode, wie in den folgenden Schritten dieses Verfahrens beschrieben.
1. Gehen Sie auf die [Super-Linter-Seite](https://github.com/marketplace/actions/super-linter) im GitHub Marketplace.
1. Suchen Sie unter `steps:` (Kleinbuchstaben) nach dem Code und fügen Sie ihn in den CodeCatalyst Workflow unter `Steps:` (Großbuchstaben) ein.
Passen Sie den GitHub Aktionscode an die CodeCatalyst Standards an, wie im folgenden Code gezeigt.
Ihr CodeCatalyst Workflow sieht jetzt wie folgt aus:
```
Name: codecatalyst-linter-workflow
SchemaVersion: "1.0"
Triggers:
- Type: PUSH
Branches:
- main
Actions:
SuperLinterAction:
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
```
1. (Optional) Wählen Sie „**Validieren**“, um sicherzustellen, dass der YAML-Code gültig ist, bevor Sie ihn festschreiben.
1. Wählen Sie **Commit**, geben Sie eine **Commit-Nachricht** ein, wählen Sie Ihr `codecatalyst-linter-source-repository` **Repository** aus und wählen Sie erneut **Commit** aus.
Sie haben jetzt einen Workflow erstellt. Eine Workflow-Ausführung wird aufgrund des oben im Workflow definierten Triggers automatisch gestartet.
**Um die laufende Workflow-Ausführung anzuzeigen**
1. **Wählen Sie im Navigationsbereich **CI/CD** und dann Workflows aus.**
1. Wählen Sie den Workflow aus, den Sie gerade erstellt haben:. `codecatalyst-linter-workflow`
1. Wählen Sie im Workflow-Diagramm **SuperLinterAction**.
1. Warten Sie, bis die Aktion fehlschlägt. Dieser Fehler wird erwartet, weil der Linter Probleme im Code gefunden hat.
1. Lassen Sie die CodeCatalyst Konsole geöffnet und gehen Sie zu[Schritt 4: Probleme beheben, die der Super-Linter gefunden hat](#integrations-github-action-tutorial-fix-probs).
## Schritt 4: Probleme beheben, die der Super-Linter gefunden hat
Der Super-Linter sollte Probleme im `app.js` Code sowie in der `README.md` Datei gefunden haben, die in Ihrem Quell-Repository enthalten ist.
**Um die Probleme zu beheben, die der Linter gefunden hat**
1. Wählen Sie in der CodeCatalyst Konsole die Registerkarte **Logs** und dann **Lint Code Base** aus.
Die Protokolle, die die Super-Linter-Aktion generiert hat, werden angezeigt.
1. Scrollen Sie in den Super-Linter-Protokollen nach unten bis etwa Zeile 90, wo Sie den Beginn der Probleme finden. Sie sehen etwa wie folgt aus:
```
/github/workspace/hello-world/app.js:3:13: Extra semicolon.
/github/workspace/hello-world/app.js:9:92: Trailing spaces not allowed.
/github/workspace/hello-world/app.js:21:7: Unnecessarily quoted property 'body' found.
/github/workspace/hello-world/app.js:31:1: Expected indentation of 2 spaces but found 4.
/github/workspace/hello-world/app.js:32:2: Newline required at end of file but not found.
```
1. Korrigieren Sie `app.js` und `README.md` in Ihrem Quell-Repository und übernehmen Sie Ihre Änderungen.
**Tipp**
Um das zu beheben`README.md`, füge `markdown` es dem Codeblock wie folgt hinzu:
```
```markdown
Setup examples:
...
```
```
Ihre Änderungen starten automatisch eine weitere Workflow-Ausführung. Warten Sie, bis der Workflow abgeschlossen ist. Wenn Sie alle Probleme behoben haben, sollte der Workflow erfolgreich sein.
## Bereinigen
Bereinigen Sie in CodeCatalyst , um Spuren dieses Tutorials aus Ihrer Umgebung zu entfernen.
**Zum Aufräumen in CodeCatalyst**
1. Öffnen Sie die CodeCatalyst Konsole unter [https://codecatalyst.aws/](https://codecatalyst.aws/).
1. Löschen`codecatalyst-linter-source-repository`.
1. Löschen`codecatalyst-linter-workflow`.
In diesem Tutorial haben Sie gelernt, wie Sie die GitHub Super-Linter-Aktion zu einem CodeCatalyst Workflow hinzufügen, um Code zu vereinfachen.
# Aktion „GitHub Aktionen“ hinzufügen
Eine ***GitHub Aktionsaktion*** ist eine *CodeCatalyst Aktion*, die eine GitHub Aktion umschließt und sie mit Workflows kompatibel macht. CodeCatalyst
Weitere Informationen finden Sie unter [Integration mit GitHub Aktionen](integrations-github-actions.md).
Gehen Sie folgendermaßen vor, um die Aktion **GitHub Aktionen** zu einem Workflow hinzuzufügen.
**Tipp**
Ein Tutorial, das Ihnen zeigt, wie Sie die Aktion **GitHub Aktionen** verwenden, finden Sie unter[Tutorial: Lint-Code mit einer GitHub Aktion](integrations-github-action-tutorial.md).
------
#### [ Visual ]
**So fügen Sie die Aktion „GitHub Aktionen“ mit dem visuellen Editor hinzu**
1. [Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.](https://codecatalyst.aws/)
1. Wählen Sie Ihr Projekt.
1. **Wählen Sie im Navigationsbereich **CI/CD** und dann Workflows aus.**
1. 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 Workflow-Namen oder -Status filtern.
1. Wählen Sie **Bearbeiten** aus.
1. Wählen Sie **Visual**.
1. Wählen Sie oben links **\$1 Aktionen**, um den Aktionskatalog zu öffnen.
1. Wählen Sie in der Drop-down-Liste die Option **GitHub**.
1. Suchen Sie nach der Aktion **GitHub Aktionen** und führen Sie einen der folgenden Schritte aus:
+ Wählen Sie das Pluszeichen (**\$1**), um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.
Oder
+ Wählen Sie **GitHub Aktionen**. Das Dialogfeld mit den Aktionsdetails wird angezeigt. In diesem Dialogfeld:
+ (Optional) Wählen Sie „**Quelltext** [anzeigen“, um den Quellcode der Aktion](workflows-view-source.md#workflows-view-source.title) anzuzeigen.
+ Wählen Sie **Zum Workflow** hinzufügen, um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.
1. Füllen Sie auf den Registerkarten **Eingaben** und **Konfiguration** die Felder nach Ihren Bedürfnissen aus. Eine Beschreibung der einzelnen Felder finden Sie unter[Aktion 'GitHub Aktionen' YAML](github-action-ref.md). Diese Referenz enthält detaillierte Informationen zu jedem Feld (und dem entsprechenden YAML-Eigenschaftswert), wie es sowohl im YAML- als auch im visuellen Editor angezeigt wird.
1. (Optional) Wählen Sie „**Validieren**“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.
1. Wählen Sie **Commit**, geben Sie eine Commit-Nachricht ein und wählen Sie erneut **Commit** aus.
------
#### [ YAML ]
**Um die Aktion „GitHub Aktionen“ mit dem YAML-Editor hinzuzufügen**
1. [Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.](https://codecatalyst.aws/)
1. Wählen Sie Ihr Projekt.
1. **Wählen Sie im Navigationsbereich **CI/CD** und dann Workflows aus.**
1. 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 Workflow-Namen oder -Status filtern.
1. Wählen Sie **Bearbeiten** aus.
1. Wählen Sie **YAML.**
1. Wählen Sie links oben **\$1 Aktionen aus, um den Aktionskatalog** zu öffnen.
1. Wählen Sie in der Drop-down-Liste die Option **GitHub**.
1. Suchen Sie nach der Aktion **GitHub Aktionen** und führen Sie einen der folgenden Schritte aus:
+ Wählen Sie das Pluszeichen (**\$1**), um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.
Oder
+ Wählen Sie **GitHub Aktionen**. Das Dialogfeld mit den Aktionsdetails wird angezeigt. In diesem Dialogfeld:
+ (Optional) Wählen Sie „**Quelltext** [anzeigen“, um den Quellcode der Aktion](workflows-view-source.md#workflows-view-source.title) anzuzeigen.
+ Wählen Sie **Zum Workflow** hinzufügen, um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.
1. Ändern Sie die Eigenschaften im YAML-Code nach Ihren Bedürfnissen. Eine Erläuterung der einzelnen verfügbaren Eigenschaften finden Sie in der[Aktion 'GitHub Aktionen' YAML](github-action-ref.md).
1. (Optional) Wählen Sie „**Validieren**“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.
1. Wählen Sie **Commit**, geben Sie eine Commit-Nachricht ein und wählen Sie erneut **Commit** aus.
------
## GitHub Aktionsdefinition 'Aktionen'
Die Aktion „**GitHub Aktionen**“ ist als eine Reihe von YAML-Eigenschaften in Ihrer Workflow-Definitionsdatei definiert. Informationen zu diesen Eigenschaften finden Sie [Aktion 'GitHub Aktionen' YAML](github-action-ref.md) in der[YAML-Workflow-Definition](workflow-reference.md).
# 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 innerhalb eines CodeCatalyst Workflows dient.
Kuratierte GitHub Aktionen sind in der [Aktion „ CodeCatalyst-authored **GitHub Actions**](integrations-github-action-add.md)“ zusammengefasst, die durch die ID identifiziert wird. `aws/github-actions-runner@v1` [Die kuratierte GitHub Aktion OSS sieht zum Beispiel wie folgt aus: TruffleHog ](https://github.com/marketplace/actions/trufflehog-oss)
```
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 durch`aws/github-actions-runner@v1`) die TruffleHog OSS-Aktion (identifiziert durch`trufflesecurity/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. Beispiel:
```
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[Integration mit GitHub Aktionen](integrations-github-actions.md).
**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](integrations-github-action-add.md).
------
#### [ Visual ]
**Um eine kuratierte GitHub Aktion mit dem visuellen Editor hinzuzufügen**
1. Öffnen Sie die CodeCatalyst Konsole unter [https://codecatalyst.aws/](https://codecatalyst.aws/).
1. Wählen Sie Ihr Projekt.
1. **Wählen Sie im Navigationsbereich **CI/CD** und dann Workflows aus.**
1. 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 Workflow-Namen oder -Status filtern.
1. Wählen Sie **Bearbeiten** aus.
1. Wählen Sie **Visual**.
1. Wählen Sie oben links **\$1 Aktionen**, um den Aktionskatalog zu öffnen.
1. Wählen Sie in der Drop-down-Liste die Option **GitHub**.
1. Suchen oder suchen Sie nach einer GitHub Aktion und führen Sie einen der folgenden Schritte aus:
+ Wählen Sie das Pluszeichen (**\$1**), um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.
Oder
+ 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](workflows-view-source.md#workflows-view-source.title) anzuzeigen.
+ Wählen Sie **Zum Workflow** hinzufügen, um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.
1. Füllen Sie auf den Registerkarten **Eingaben**, **Konfiguration** und **Ausgaben** die Felder nach Ihren Bedürfnissen aus. Eine Beschreibung der einzelnen Felder finden Sie unter[Aktion 'GitHub Aktionen' YAML](github-action-ref.md). 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.
1. (Optional) Wählen Sie „**Validieren**“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.
1. 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/.](https://codecatalyst.aws/)
1. Wählen Sie Ihr Projekt.
1. **Wählen Sie im Navigationsbereich **CI/CD** und dann Workflows aus.**
1. 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 Workflow-Namen oder -Status filtern.
1. Wählen Sie **Bearbeiten** aus.
1. Wählen Sie **YAML.**
1. Wählen Sie links oben **\$1 Aktionen aus, um den Aktionskatalog** zu öffnen.
1. Wählen Sie in der Drop-down-Liste die Option **GitHub**.
1. Suchen oder suchen Sie nach einer GitHub Aktion und führen Sie einen der folgenden Schritte aus:
+ Wählen Sie das Pluszeichen (**\$1**), um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.
Oder
+ 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](workflows-view-source.md#workflows-view-source.title) anzuzeigen.
+ Wählen Sie **Zum Workflow** hinzufügen, um die Aktion zum Workflow-Diagramm hinzuzufügen und den zugehörigen Konfigurationsbereich zu öffnen.
1. Ä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. [Aktion 'GitHub Aktionen' YAML](github-action-ref.md)
Informationen zu den Konfigurationsoptionen, die für die kuratierte GitHub Aktion verfügbar sind, finden Sie in der zugehörigen Dokumentation.
1. (Optional) Wählen Sie „**Validieren**“, um den YAML-Code des Workflows vor dem Commit zu überprüfen.
1. Wählen Sie **Commit**, geben Sie eine Commit-Nachricht ein und wählen Sie erneut **Commit** aus.
------
# GitHub Ausgabeparameter exportieren
Sie können [GitHub Ausgabeparameter](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter) in Ihren CodeCatalyst Workflows verwenden.
**Anmerkung**
Ein anderes Wort für *Ausgabeparameter* ist *variabel*. Da in der Dokumentation der Begriff *Ausgabeparameter GitHub * verwendet wird, werden wir diesen Begriff auch verwenden.
Verwenden Sie die folgenden Anweisungen, um einen GitHub Ausgabeparameter aus einer GitHub Aktion zu exportieren, sodass er für andere CodeCatalyst Workflow-Aktionen verfügbar ist.
**Um einen GitHub Ausgabeparameter zu exportieren**
1. Öffnen Sie einen Workflow und wählen Sie **Bearbeiten**. Weitere Informationen finden Sie unter [Einen Workflow erstellen](workflows-create-workflow.md).
1. Fügen Sie in der Aktion **GitHub Aktionen**, die den Ausgabeparameter generiert, den Sie exportieren möchten, einen `Outputs` Abschnitt mit einer zugrunde liegenden `Variables` Eigenschaft hinzu, die wie folgt aussieht:
```
Actions:
MyGitHubAction:
Identifier: aws/github-actions-runner@v1
Outputs:
Variables:
- 'step-id_output-name'
```
Ersetze:
+ *step-id*mit dem Wert der `id:` Eigenschaft im `steps` Abschnitt der GitHub Aktion.
+ *output-name*mit dem Namen des GitHub Ausgabeparameters.
**Beispiel**
Das folgende Beispiel zeigt Ihnen, wie Sie einen GitHub Ausgabeparameter namens exportieren`SELECTEDCOLOR`.
```
Actions:
MyGitHubAction:
Identifier: aws/github-actions-runner@v1
Outputs:
Variables:
- 'random-color-generator_SELECTEDCOLOR'
Configuration:
Steps:
- name: Set selected color
run: echo "SELECTEDCOLOR=green" >> $GITHUB_OUTPUT
id: random-color-generator
```
# Referenzieren von GitHub Ausgabeparametern
Verwenden Sie die folgenden Anweisungen, um auf einen GitHub Ausgabeparameter zu verweisen.
**Um auf einen GitHub Ausgabeparameter zu verweisen**
1. Führen Sie die Schritte unter [GitHub Ausgabeparameter exportieren](integrations-github-action-export.md) aus.
Der GitHub Ausgabeparameter ist jetzt für die Verwendung in anderen Aktionen verfügbar.
1. Notieren Sie sich den `Variables` Wert des Ausgabeparameters. Er enthält einen Unterstrich (\$1).
1. Verwenden Sie für den Ausgabeparameter die folgende Syntax:
```
${action-name.output-name}
```
Ersetzen Sie:
+ *action-name*mit dem Namen der CodeCatalyst **GitHub Aktion**, die den Ausgabeparameter erzeugt (verwenden Sie nicht das `name` oder der GitHub Aktion`id`).
+ *output-name*mit dem `Variables` Wert des Ausgabeparameters, den Sie zuvor notiert haben.
**Beispiel**
```
BuildActionB:
Identifier: aws/build@v1
Configuration:
Steps:
- Run: echo ${MyGitHubAction.random-color-generator_SELECTEDCOLOR}
```
**Beispiel mit Kontext**
Das folgende Beispiel zeigt Ihnen, wie Sie eine `SELECTEDCOLOR` Variable eingeben`GitHubActionA`, ausgeben und dann in darauf verweisen`BuildActionB`.
```
Actions:
GitHubActionA:
Identifier: aws/github-actions-runner@v1
Configuration:
Steps:
- name: Set selected color
run: echo "SELECTEDCOLOR=green" >> $GITHUB_OUTPUT
id: random-color-generator
Outputs:
Variables:
- 'random-color-generator_SELECTEDCOLOR'
BuildActionB:
Identifier: aws/build@v1
Configuration:
Steps:
- Run: echo ${GitHubActionA.random-color-generator_SELECTEDCOLOR}
```
# Aktion 'GitHub Aktionen' YAML
Im Folgenden finden Sie die YAML-Definition der Aktion **GitHubAktionen**.
Diese Aktionsdefinition ist als Abschnitt in einer umfassenderen Workflow-Definitionsdatei vorhanden. Weitere Informationen über diese Datei finden Sie unter [YAML-Workflow-Definition](workflow-reference.md).
Wählen Sie im folgenden Code eine YAML-Eigenschaft aus, um eine Beschreibung zu erhalten.
**Anmerkung**
Die meisten der folgenden YAML-Eigenschaften haben entsprechende Benutzeroberflächenelemente im visuellen Editor. Verwenden Sie **Strg\$1F**, um nach einem UI-Element zu suchen. Das Element wird mit der zugehörigen YAML-Eigenschaft aufgelistet.
```
# The workflow definition starts here.
# See Eigenschaften der obersten Ebene for details.
Name: MyWorkflow
SchemaVersion: 1.0
Actions:
# The action definition starts here.
action-name:
Identifier: aws/github-actions-runner@v1
DependsOn:
- dependent-action-name-1
Compute:
Fleet: fleet-name
Timeout: timeout-minutes
Environment:
Name: environment-name
Connections:
- Name: account-connection-name
Role: iam-role-name
Inputs:
Sources:
- source-name-1
- source-name-2
Artifacts:
- artifact-name
Variables:
- Name: variable-name-1
Value: variable-value-1
- Name: variable-name-2
Value: variable-value-2
Outputs:
Artifacts:
- Name: output-artifact-1
Files:
- github-output/artifact-1.jar
- "github-output/build*"
- Name: output-artifact-2
Files:
- github-output/artifact-2.1.jar
- github-output/artifact-2.2.jar
Variables:
- variable-name-1
- variable-name-2
AutoDiscoverReports:
Enabled: true | false
ReportNamePrefix: AutoDiscovered
IncludePaths:
- "**/*"
ExcludePaths:
- node_modules/cdk/junit.xml
SuccessCriteria:
PassRate: percent
LineCoverage: percent
BranchCoverage: percent
Vulnerabilities:
Severity: CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL
Number: whole-number
Reports:
report-name-1:
Format: format
IncludePaths:
- "*.xml"
ExcludePaths:
- report2.xml
- report3.xml
SuccessCriteria:
PassRate: percent
LineCoverage: percent
BranchCoverage: percent
Vulnerabilities:
Severity: CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL
Number: whole-number
Configuration
Steps:
- github-actions-code
```
## Aktionsname
(Erforderlich)
Geben Sie den Namen der Aktion an. Alle Aktionsnamen müssen innerhalb des Workflows eindeutig sein. Aktionsnamen sind auf alphanumerische Zeichen (a-z, A-Z, 0-9), Bindestriche (-) und Unterstriche (\$1) beschränkt. Leerzeichen sind nicht erlaubt. Sie können keine Anführungszeichen verwenden, um Sonderzeichen und Leerzeichen in Aktionsnamen zuzulassen.
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“/*action-name*
## Identifier
(*action-name*/**Identifier**)
Identifiziert die Aktion. Ändern Sie diese Eigenschaft nur, wenn Sie die Version ändern möchten. Weitere Informationen finden Sie unter [Angabe der zu verwendenden Aktionsversion](workflows-action-versions.md).
`aws/github-actions-runner@v1`Für **GitHubAktionen** verwenden.
Entsprechende Benutzeroberfläche: *action-name* **Workflow-Diagram/aws/ @v1 label github-actions-runner**
## DependsOn
(*action-name*/**DependsOn**)
(Optional)
Geben Sie eine Aktion, eine Aktionsgruppe oder ein Gate an, die erfolgreich ausgeführt werden müssen, damit diese Aktion ausgeführt werden kann.
Weitere Hinweise zur Funktion „Hängt davon ab“ finden Sie unter. [Aktionen sequenzieren](workflows-depends-on.md)
Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“/„**Hängt davon ab**“ — optional
## Compute
(*action-name*/**Compute**)
(Optional)
Die Rechen-Engine, mit der Ihre Workflow-Aktionen ausgeführt wurden. Sie können die Berechnung entweder auf Workflow-Ebene oder auf Aktionsebene angeben, aber nicht beide. Wenn auf Workflow-Ebene angegeben, gilt die Rechenkonfiguration für alle im Workflow definierten Aktionen. Auf Workflow-Ebene können Sie auch mehrere Aktionen auf derselben Instanz ausführen. Weitere Informationen finden Sie unter [Rechenleistung für mehrere Aktionen gemeinsam nutzen](compute-sharing.md).
Entsprechende Benutzeroberfläche: *keine*
## Fleet
(*action-name*/Compute/**Fleet**)
(Optional)
Geben Sie die Maschine oder Flotte an, auf der Ihr Workflow oder Ihre Workflow-Aktionen ausgeführt werden sollen. Bei bedarfsgesteuerten Flotten stellt der Workflow zu Beginn einer Aktion die benötigten Ressourcen bereit, und die Maschinen werden zerstört, wenn die Aktion abgeschlossen ist. Beispiele für Flotten auf Abruf:`Linux.x86-64.Large`,. `Linux.x86-64.XLarge` Weitere Informationen zu Flotten auf Abruf finden Sie unter. [Eigenschaften von On-Demand-Flotten](workflows-working-compute.md#compute.on-demand)
Bei bereitgestellten Flotten konfigurieren Sie eine Reihe von dedizierten Maschinen, um Ihre Workflow-Aktionen auszuführen. Diese Maschinen bleiben inaktiv und sind bereit, Aktionen sofort zu verarbeiten. Weitere Informationen zu bereitgestellten Flotten finden Sie unter. [Eigenschaften von bereitgestellten Flotten](workflows-working-compute.md#compute.provisioned-fleets)
Wenn `Fleet` es weggelassen wird, ist die Standardeinstellung. `Linux.x86-64.Large`
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“/„**Compute Fleet“ — optional**
## Timeout
(*action-name*/**Timeout**)
(Optional)
Geben Sie an, wie lange die Aktion in Minuten (YAML-Editor) oder Stunden und Minuten (visueller Editor) ausgeführt werden kann, bevor die Aktion CodeCatalyst beendet wird. Das Minimum beträgt 5 Minuten und das Maximum ist unter beschrieben[Kontingente für Workflows in CodeCatalyst](workflows-quotas.md). Das Standard-Timeout entspricht dem maximalen Timeout.
**Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Timeout“ — optional**
## Environment
(*action-name*/**Environment**)
(Optional)
Geben Sie die CodeCatalyst Umgebung an, die für die Aktion verwendet werden soll. Die Aktion stellt eine Verbindung mit der AWS-Konto optionalen Amazon VPC her, die in der ausgewählten Umgebung angegeben ist. Die Aktion verwendet die in der Umgebung angegebene Standard-IAM-Rolle, um sich mit der Amazon VPC zu verbinden AWS-Konto, und verwendet die in der [Amazon VPC-Verbindung angegebene IAM-Rolle, um eine Verbindung zur Amazon VPC](https://docs.aws.amazon.com/codecatalyst/latest/adminguide/managing-vpcs.add.html) herzustellen.
**Anmerkung**
Wenn die Standard-IAM-Rolle nicht über die für die Aktion erforderlichen Berechtigungen verfügt, können Sie die Aktion so konfigurieren, dass sie eine andere Rolle verwendet. Weitere Informationen finden Sie unter [Die IAM-Rolle einer Aktion ändern](deploy-environments-switch-role.md).
Weitere Informationen zu Umgebungen finden Sie unter [Einsatz in AWS-Konten und VPCs](deploy-environments.md) und[Erstellen einer Umgebung](deploy-environments-creating-environment.md).
**Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Umgebung“**
## Name
(*action-name*/Environment/**Name**)
(Erforderlich, falls [Environment](#github.environment) enthalten)
Geben Sie den Namen einer vorhandenen Umgebung an, die Sie der Aktion zuordnen möchten.
**Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Umgebung“**
## Connections
(*action-name*/Environment/**Connections**)
(Optional)
Geben Sie die Kontoverbindung an, die der Aktion zugeordnet werden soll. Sie können unter maximal eine Kontoverbindung angeben`Environment`.
Wenn Sie keine Kontoverbindung angeben:
+ Die Aktion verwendet die AWS-Konto Verbindung und die Standard-IAM-Rolle, die in der Umgebung in der CodeCatalyst Konsole angegeben sind. Informationen zum Hinzufügen einer Kontoverbindung und einer Standard-IAM-Rolle zur Umgebung finden Sie unter. [Erstellen einer Umgebung](deploy-environments-creating-environment.md)
+ Die Standard-IAM-Rolle muss die Richtlinien und Berechtigungen enthalten, die für die Aktion erforderlich sind. **Informationen zu diesen Richtlinien und Berechtigungen finden Sie in der Beschreibung der Role-Eigenschaft in der YAML-Definitionsdokumentation der Aktion.**
Weitere Informationen zu Kontoverbindungen finden Sie unter[Ermöglichen des Zugriffs auf AWS Ressourcen mit verbundenen AWS-Konten](ipa-connect-account.md). Hinweise zum Hinzufügen einer Kontoverbindung zu einer Umgebung finden Sie unter[Erstellen einer Umgebung](deploy-environments-creating-environment.md).
Entsprechende Benutzeroberfläche: Ist tab/Environment/What die Konfiguration aktiviert*my-environment*? **/Dreipunktmenü/ Rolle wechseln**
## Name
(*action-name*/Environment/Connections/**Name**)
(Erforderlich, falls enthalten[Connections](#github.environment.connections))
Geben Sie den Namen der Kontoverbindung an.
Entsprechende Benutzeroberfläche: Ist tab/Environment/What die Konfiguration aktiviert*my-environment*? **/Dreipunktmenü/ Rolle wechseln**
## Role
(*action-name*/Environment/Connections/**Role**)
(Erforderlich, falls enthalten[Connections](#github.environment.connections))
Geben Sie den Namen der IAM-Rolle an, die diese Aktion verwendet, um auf AWS Dienste wie Amazon S3 und Amazon ECR zuzugreifen und diese zu nutzen. Stellen Sie sicher, dass diese Rolle zu Ihrer AWS-Konto Verbindung in Ihrem Bereich hinzugefügt wird. Informationen zum Hinzufügen einer IAM-Rolle zu einer Kontoverbindung finden Sie unter[Hinzufügen von IAM-Rollen zu Kontoverbindungen](ipa-connect-account-addroles.md).
Wenn Sie keine IAM-Rolle angeben, verwendet die Aktion die Standard-IAM-Rolle, die in der [Umgebung](deploy-environments.md) in der Konsole aufgeführt ist. CodeCatalyst Wenn Sie die Standardrolle in der Umgebung verwenden, stellen Sie sicher, dass sie über die folgenden Richtlinien verfügt.
**Anmerkung**
Sie können die `CodeCatalystWorkflowDevelopmentRole-spaceName` Rolle mit dieser Aktion verwenden. Weitere Informationen über diese Rolle finden Sie unter [Die **CodeCatalystWorkflowDevelopmentRole-*spaceName***Rolle für Ihr Konto und Ihren Bereich erstellen](ipa-iam-roles.md#ipa-iam-roles-service-create). Beachten Sie, dass die `CodeCatalystWorkflowDevelopmentRole-spaceName` Rolle über volle Zugriffsberechtigungen verfügt, was ein Sicherheitsrisiko darstellen kann. Wir empfehlen, diese Rolle nur in Tutorials und Szenarien zu verwenden, in denen die Sicherheit weniger wichtig ist.
**Warnung**
Beschränken Sie die Berechtigungen auf diejenigen, die für die **GitHub Aktion Aktion** erforderlich sind. Die Verwendung einer Rolle mit umfassenderen Berechtigungen kann ein Sicherheitsrisiko darstellen.
Entsprechende Benutzeroberfläche: tab/Environment/What Die Konfiguration ist aktiviert*my-environment*? **/Dreipunktmenü/ Rolle wechseln**
## Inputs
(*action-name*/**Inputs**)
(Optional)
`Inputs`In diesem Abschnitt werden die Daten definiert, die eine Aktion während einer Workflow-Ausführung benötigt.
**Anmerkung**
Pro **GitHub Aktionsaktion** sind maximal vier Eingaben (eine Quelle und drei Artefakte) zulässig. Variablen werden auf diese Summe nicht angerechnet.
Wenn Sie auf Dateien verweisen müssen, die sich in unterschiedlichen Eingaben befinden (z. B. eine Quelle und ein Artefakt), ist die Quelleingabe die primäre Eingabe und das Artefakt die sekundäre Eingabe. Verweise auf Dateien in sekundären Eingaben benötigen ein spezielles Präfix, um sie von der primären Eingabe zu unterscheiden. Details hierzu finden Sie unter [Beispiel: Referenzieren von Dateien in mehreren Artefakten](workflows-working-artifacts-ex.md#workflows-working-artifacts-ex-ref-file).
**Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“**
## Sources
(*action-name*/Inputs/**Sources**)
(Optional)
Geben Sie die Labels an, die die Quell-Repositorys repräsentieren, die für die Aktion benötigt werden. Derzeit wird nur die Bezeichnung, die das Quell-Repository darstellt`WorkflowSource`, in dem Ihre Workflow-Definitionsdatei gespeichert ist, unterstützt.
Wenn Sie eine Quelle weglassen, müssen Sie mindestens ein Eingabeartefakt unter angeben. `action-name/Inputs/Artifacts`
Weitere Informationen zu Quellen finden Sie unter [Quell-Repositorys mit Workflows verbinden](workflows-sources.md).
**Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“/„Quellen“ — optional**
## Artifacts - input
(*action-name*/Inputs/**Artifacts**)
(Optional)
Geben Sie Artefakte aus früheren Aktionen an, die Sie als Eingabe für diese Aktion bereitstellen möchten. Diese Artefakte müssen bereits in früheren Aktionen als Ausgabeartefakte definiert sein.
Wenn Sie keine Eingabeartefakte angeben, müssen Sie mindestens ein Quell-Repository unter angeben`action-name/Inputs/Sources`.
Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unter[Artefakte und Dateien zwischen Aktionen teilen](workflows-working-artifacts.md).
**Anmerkung**
Wenn die Dropdownliste **Artefakte — optional** nicht verfügbar ist (visueller Editor) oder wenn Sie bei der Validierung Ihres YAML (YAML-Editors) Fehler erhalten, liegt das möglicherweise daran, dass die Aktion nur eine Eingabe unterstützt. Versuchen Sie in diesem Fall, die Quelleingabe zu entfernen.
Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“/„**Artefakte“ — optional**
## Variables - input
(*action-name*/Inputs/**Variables**)
(Optional)
Geben Sie eine Sequenz von name/value 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 (\$1) 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 unter[Verwenden von Variablen in Workflows](workflows-working-with-variables.md).
Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“/„**Variablen“ — optional**
## Outputs
(*action-name*/**Outputs**)
(Optional)
Definiert die Daten, die von der Aktion während einer Workflow-Ausführung ausgegeben werden.
Entsprechende Benutzeroberfläche: Registerkarte „**Ausgaben**“
## Artifacts - output
(*action-name*/Outputs/**Artifacts**)
(Optional)
Geben Sie den Namen eines Artefakts an, das durch die Aktion generiert wurde. Artefaktnamen müssen innerhalb eines Workflows eindeutig sein und sind auf alphanumerische Zeichen (a-z, A-Z, 0-9) und Unterstriche (\$1) beschränkt. Leerzeichen, Bindestriche (-) und andere Sonderzeichen sind nicht zulässig. Sie können keine Anführungszeichen verwenden, um Leerzeichen, Bindestriche und andere Sonderzeichen in Namen von Ausgabeartefakten zuzulassen.
Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unter. [Artefakte und Dateien zwischen Aktionen teilen](workflows-working-artifacts.md)
**Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Artefakte**
## Name
(*action-name*/Outputs/Artifacts/**Name**)
(Erforderlich, wenn [Artifacts - output](#github.outputs.artifacts) es enthalten ist)
Geben Sie den Namen eines Artefakts an, das durch die Aktion generiert wurde. Artefaktnamen müssen innerhalb eines Workflows eindeutig sein und sind auf alphanumerische Zeichen (a-z, A-Z, 0-9) und Unterstriche (\$1) beschränkt. Leerzeichen, Bindestriche (-) und andere Sonderzeichen sind nicht zulässig. Sie können keine Anführungszeichen verwenden, um Leerzeichen, Bindestriche und andere Sonderzeichen in Namen von Ausgabeartefakten zuzulassen.
Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unter. [Artefakte und Dateien zwischen Aktionen teilen](workflows-working-artifacts.md)
**Entsprechende Benutzeroberfläche: Gibt den Namen des tab/Artifacts/Add Artefakts aus/Den Namen des Build-Artefakts**
## Files
(*action-name*/Outputs/Artifacts/**Files**)
(Erforderlich, wenn es enthalten ist) [Artifacts - output](#github.outputs.artifacts)
Geben Sie die Dateien an, die in dem Artefakt CodeCatalyst enthalten sind, das von der Aktion ausgegeben wird. Diese Dateien werden durch die Workflow-Aktion generiert, wenn sie ausgeführt wird, und sind auch in Ihrem Quell-Repository verfügbar. Dateipfade können sich in einem Quell-Repository oder einem Artefakt aus einer früheren Aktion befinden und sind relativ zum Quell-Repository oder Artefakt-Stamm. Sie können Glob-Muster verwenden, um Pfade anzugeben. Beispiele:
+ Um eine einzelne Datei anzugeben, die sich im Stammverzeichnis Ihres Build-Speicherorts oder Quell-Repository-Speicherorts befindet, verwenden Sie`my-file.jar`.
+ Um eine einzelne Datei in einem Unterverzeichnis anzugeben, verwenden Sie `directory/my-file.jar` oder`directory/subdirectory/my-file.jar`.
+ Um alle Dateien anzugeben, verwenden Sie`"**/*"`. Das `**` Glob-Muster gibt an, dass es einer beliebigen Anzahl von Unterverzeichnissen entspricht.
+ Um alle Dateien und Verzeichnisse in einem Verzeichnis mit dem Namen anzugeben`directory`, verwenden Sie. `"directory/**/*"` Das `**` Glob-Muster gibt an, dass es einer beliebigen Anzahl von Unterverzeichnissen entspricht.
+ Um alle Dateien in einem Verzeichnis mit dem Namen`directory`, aber nicht in einem seiner Unterverzeichnisse anzugeben, verwenden Sie. `"directory/*"`
**Anmerkung**
Wenn Ihr Dateipfad ein oder mehrere Sternchen (`*`) oder ein anderes Sonderzeichen enthält, schließen Sie den Pfad in doppelte Anführungszeichen () ein. `""` Weitere Hinweise zu Sonderzeichen finden Sie unter. [Richtlinien und Konventionen zur Syntax](workflow-reference.md#workflow.terms.syntax.conv)
Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unter[Artefakte und Dateien zwischen Aktionen teilen](workflows-working-artifacts.md).
**Anmerkung**
Möglicherweise müssen Sie dem Dateipfad ein Präfix hinzufügen, um anzugeben, in welchem Artefakt oder in welcher Quelle das Objekt gefunden werden soll. Weitere Informationen erhalten Sie unter [Quell-Repository-Dateien referenzieren](workflows-sources-reference-files.md) und [Referenzieren von Dateien in einem Artefakt](workflows-working-artifacts-refer-files.md).
**Entsprechende Benutzeroberfläche: Gibt tab/Artifacts/Add Artefakte/Dateien aus, die von build erzeugt wurden**
## Variables - output
(*action-name*/Outputs/**Variables**)
(Optional)
Geben Sie die Variablen an, die die Aktion exportieren soll, damit sie für nachfolgende Aktionen verfügbar sind.
Weitere Informationen zu Variablen, einschließlich Beispielen, finden Sie unter[Verwenden von Variablen in Workflows](workflows-working-with-variables.md).
**Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Variablen/Variable hinzufügen**
## Variablenname-1
**(Variablenname-1 *action-name*/Outputs/Variables)**
(Optional)
Geben Sie den Namen einer Variablen an, die von der Aktion exportiert werden soll. Diese Variable muss bereits im `Steps` Abschnitt `Inputs` oder derselben Aktion definiert sein.
Weitere Hinweise zu Variablen, einschließlich Beispielen, finden Sie unter[Verwenden von Variablen in Workflows](workflows-working-with-variables.md).
**Entsprechende Benutzeroberfläche: Gibt tab/Variables/Add Variable/ Namen aus**
## AutoDiscoverReports
(*action-name*/Outputs/**AutoDiscoverReports**)
(Optional)
Definiert die Konfiguration für die Auto-Discovery-Funktion.
Wenn Sie die automatische Erkennung aktivieren, werden alle `Inputs` an die Aktion übergebenen sowie alle von der Aktion selbst generierten Dateien CodeCatalyst durchsucht, wobei nach Test-, Codeabdeckungs- und SCA-Berichten (Software Composition Analysis) gesucht wird. Wandelt jeden gefundenen Bericht in einen CodeCatalyst Bericht um. CodeCatalyst Ein *CodeCatalyst Bericht* ist ein Bericht, der vollständig in den CodeCatalyst Service integriert ist und über die Konsole angezeigt und bearbeitet werden kann. CodeCatalyst
**Anmerkung**
Standardmäßig überprüft die automatische Erkennungsfunktion alle Dateien. Mithilfe der Eigenschaften [IncludePaths](#github.reports.includepaths) oder [ExcludePaths](#github.reports.excludepaths) können Sie einschränken, welche Dateien überprüft werden.
Entsprechende Benutzeroberfläche: *keine*
## Enabled
(*action-name*/Outputs/AutoDiscoverReports/**Enabled**)
(Optional)
Aktivieren oder deaktivieren Sie die automatische Erkennungsfunktion.
Gültige Werte sind `true` oder `false`.
Wenn `Enabled` es weggelassen wird, ist `true` die Standardeinstellung.
**Entsprechende Benutzeroberfläche: Registerkarte „Ausgaben/Berichte“/Berichte automatisch erkennen**
## ReportNamePrefix
(*action-name*/Outputs/AutoDiscoverReports/**ReportNamePrefix**)
(Erforderlich, wenn es enthalten und aktiviert [AutoDiscoverReports](#github.outputs.autodiscover) ist)
Geben Sie ein Präfix an, das allen gefundenen Berichten CodeCatalyst vorangestellt wird, um die zugehörigen CodeCatalyst Berichte zu benennen. Wenn Sie beispielsweise das Präfix von `AutoDiscovered` angeben und zwei Testberichte CodeCatalyst automatisch erkennen, erhalten die zugehörigen CodeCatalyst Berichte den Namen `TestSuiteOne.xml` `AutoDiscoveredTestSuiteOne` und`TestSuiteTwo.xml`. `AutoDiscoveredTestSuiteTwo`
**Entsprechende Benutzeroberfläche: Gibt tab/Reports/Automatically Erkennungsberichte/Berichtspräfix aus**
## IncludePaths
(*action-name*/Outputs/AutoDiscoverReports/**IncludePaths**)
Oder
(*action-name*/Outputs/Reports/*report-name-1*/**IncludePaths**)
(Erforderlich, wenn [AutoDiscoverReports](#github.outputs.autodiscover) es enthalten und aktiviert ist, oder wenn [Reports](#github.configuration.reports) es enthalten ist)
Geben Sie die Dateien und Dateipfade an, CodeCatalyst die bei der Suche nach Rohberichten berücksichtigt werden. Wenn Sie beispielsweise angeben`"/test/report/*"`, wird das gesamte [Build-Image](build-images.md), das von der Aktion verwendet wurde, nach dem `/test/report/*` Verzeichnis CodeCatalyst durchsucht. Wenn das Verzeichnis gefunden CodeCatalyst wird, wird in diesem Verzeichnis nach Berichten gesucht.
**Anmerkung**
Wenn Ihr Dateipfad ein oder mehrere Sternchen (`*`) oder andere Sonderzeichen enthält, schließen Sie den Pfad in doppelte Anführungszeichen () ein. `""` Weitere Hinweise zu Sonderzeichen finden Sie unter. [Richtlinien und Konventionen zur Syntax](workflow-reference.md#workflow.terms.syntax.conv)
Wenn diese Eigenschaft weggelassen wird, ist die Standardeinstellung`"**/*"`, was bedeutet, dass die Suche alle Dateien in allen Pfaden umfasst.
**Anmerkung**
Bei manuell konfigurierten Berichten `IncludePaths` muss es sich um ein Glob-Muster handeln, das einer einzelnen Datei entspricht.
Entsprechende Benutzeroberfläche:
+ **Gibt Pfade tab/Reports/Automatically discover reports/'Include/exclude aus/Pfade einschließen**
+ **Ausgaben tab/Reports/Manually konfigurieren Berichte/ /'Pfade einschließen/ausschließen'/ Pfade *report-name-1* einschließen**
## ExcludePaths
(*action-name*/Outputs/AutoDiscoverReports/**ExcludePaths**)
Oder
(*action-name*/Outputs/Reports/*report-name-1*/**ExcludePaths**)
(Optional)
Geben Sie die Dateien und Dateipfade an, die bei der Suche nach Rohberichten ausgeschlossen werden sollen. CodeCatalyst Wenn Sie beispielsweise angeben`"/test/my-reports/**/*"`, CodeCatalyst wird nicht nach Dateien im `/test/my-reports/` Verzeichnis gesucht. Um alle Dateien in einem Verzeichnis zu ignorieren, verwenden Sie das `**/*` Glob-Muster.
**Anmerkung**
Wenn Ihr Dateipfad ein oder mehrere Sternchen (`*`) oder andere Sonderzeichen enthält, schließen Sie den Pfad in doppelte Anführungszeichen () ein. `""` Weitere Hinweise zu Sonderzeichen finden Sie unter. [Richtlinien und Konventionen zur Syntax](workflow-reference.md#workflow.terms.syntax.conv)
Entsprechende Benutzeroberfläche:
+ **Gibt tab/Reports/Automatically discover reports/'Include/exclude Pfade aus/Pfade ausschließen**
+ **Gibt Berichte tab/Reports/Manually konfigurieren/ /'Pfade einschließen/ausschließen'/ Pfade ausschließen/ Pfade ausschließen *report-name-1***
## SuccessCriteria
(*action-name*/Outputs/AutoDiscoverReports/**SuccessCriteria**)
Oder
(*action-name*/Outputs/Reports/*report-name-1*/**SuccessCriteria**)
(Optional)
Geben Sie die Erfolgskriterien für die Berichte Test, Codeabdeckung, Software Composition Analysis (SCA) und Static Analysis (SA) an.
Weitere Informationen finden Sie unter [Erfolgskriterien für Berichte konfigurieren](test-config-action.md#test.success-criteria).
Entsprechende Benutzeroberfläche:
+ **Ergebnisse: tab/Reports/Automatically Entdeckungsberichte/Erfolgskriterien**
+ **Ausgaben tab/Reports/Manually konfigurieren Berichte// Erfolgskriterien *report-name-1***
## PassRate
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**PassRate**)
Oder
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**PassRate**)
(Optional)
Geben Sie den Prozentsatz der Tests in einem Testbericht an, die bestanden werden müssen, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Zu den gültigen Werten gehören Dezimalzahlen. Zum Beispiel: `50`, `60.5`. Die Kriterien für die Erfolgsquote werden nur auf Testberichte angewendet. Weitere Informationen zu Testberichten finden Sie unter[Testberichte](test-workflow-actions.md#test-reports).
Entsprechende Benutzeroberfläche:
+ **Gibt tab/Reports/Automatically discover reports/Success Kriterien/Erfolgsquote aus**
+ **Ausgaben tab/Reports/Manually konfigurieren Berichte/ /Erfolgskriterien/ Erfolgsquote *report-name-1***
## LineCoverage
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**LineCoverage**)
Oder
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**LineCoverage**)
(Optional)
Geben Sie den Prozentsatz der Zeilen in einem Bericht über die Codeabdeckung an, die abgedeckt sein müssen, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Zu den gültigen Werten gehören Dezimalzahlen. Zum Beispiel: `50`, `60.5`. Die Kriterien für die Leitungsabdeckung werden nur auf Berichte zur Codeabdeckung angewendet. Weitere Informationen zu Berichten über die Codeabdeckung finden Sie unter[Code-Abdeckungsberichte](test-workflow-actions.md#test-code-coverage-reports).
Entsprechende Benutzeroberfläche:
+ **Gibt tab/Reports/Automatically discover reports/Success Kriterien/Leitungsabdeckung aus**
+ **Ausgaben tab/Reports/Manually konfigurieren Berichte/ /Erfolgskriterien/ Leitungsabdeckung *report-name-1***
## BranchCoverage
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**BranchCoverage**)
Oder
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**BranchCoverage**)
(Optional)
Geben Sie den Prozentsatz der Zweige in einem Bericht zur Codeabdeckung an, die abgedeckt werden müssen, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Gültige Werte beinhalten Dezimalzahlen. Zum Beispiel: `50`, `60.5`. Die Kriterien für die Abdeckung von Filialen werden nur auf Berichte zur Codeabdeckung angewendet. Weitere Informationen zu Berichten über die Codeabdeckung finden Sie unter[Code-Abdeckungsberichte](test-workflow-actions.md#test-code-coverage-reports).
Entsprechende Benutzeroberfläche:
+ tab/Reports/Automatically discover reports/Success**Ausgabekriterien/Abdeckung der Filialen**
+ **Ausgaben tab/Reports/Manually konfigurieren Berichte/ /Erfolgskriterien/ Abdeckung *report-name-1* der Filialen**
## Vulnerabilities
(*action-name*/Outputs/AutoDiscoverReports/SuccessCriteria/**Vulnerabilities**)
Oder
(*action-name*/Outputs/Reports/*report-name-1*/SuccessCriteria/**Vulnerabilities**)
(Optional)
Geben Sie die maximale Anzahl und den Schweregrad der Sicherheitslücken an, die im SCA-Bericht zulässig sind, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Um Sicherheitslücken zu spezifizieren, müssen Sie Folgendes angeben:
+ Der Mindestschweregrad der Sicherheitsanfälligkeiten, die Sie in die Zählung einbeziehen möchten. Gültige Werte, vom höchsten bis zum geringsten Schweregrad, sind: `CRITICAL``HIGH`,`MEDIUM`,,`LOW`,`INFORMATIONAL`.
Wenn Sie beispielsweise wählen `HIGH``HIGH`, werden alle `CRITICAL` Sicherheitslücken gezählt.
+ Die maximale Anzahl von Sicherheitslücken mit dem angegebenen Schweregrad, die Sie zulassen möchten. Wenn diese Zahl überschritten wird, wird der CodeCatalyst Bericht als fehlgeschlagen markiert. Gültige Werte sind ganze Zahlen.
Die Kriterien für Sicherheitslücken werden nur auf SCA-Berichte angewendet. Weitere Informationen zu SCA-Berichten finden Sie unter[Berichte zur Analyse der Softwarezusammensetzung](test-workflow-actions.md#test-sca-reports).
Verwenden Sie die `Severity` Eigenschaft, um den Mindestschweregrad anzugeben. Verwenden Sie die `Number` Eigenschaft, um die maximale Anzahl von Sicherheitslücken anzugeben.
Weitere Informationen zu SCA-Berichten finden Sie unter[Typen von Qualitätsberichten](test-workflow-actions.md#test-reporting).
Entsprechende Benutzeroberfläche:
+ **Gibt tab/Reports/Automatically discover reports/Success Kriterien/Sicherheitslücken aus**
+ **Ausgaben tab/Reports/Manually konfigurieren *report-name-1* Berichte/ /Erfolgskriterien/ Sicherheitslücken**
## Reports
(*action-name*/Outputs/**Reports** )
(Optional)
Ein Abschnitt, der die Konfiguration für Testberichte spezifiziert.
**Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Berichte**
## Berichtsname-1
**(Berichtsname-1) *action-name* /Outputs/Reports/**
(Erforderlich, falls enthalten) [Reports](#github.configuration.reports)
Der Name, den Sie dem CodeCatalyst Bericht geben möchten, der aus Ihren Rohberichten generiert wird.
**Entsprechende Benutzeroberfläche: Ausgaben, Berichte tab/Reports/Manually konfigurieren/Berichtsname**
## Format
(*action-name*/Outputs/Reports/*report-name-1*/**Format**)
(Erforderlich, falls enthalten[Reports](#github.configuration.reports))
Geben Sie das Dateiformat an, das Sie für Ihre Berichte verwenden. Mögliche Werte können sein wie folgt.
+ Für Testberichte:
+ Geben Sie für Cucumber JSON **Cucumber** (visueller Editor) oder `CUCUMBERJSON` (YAML-Editor) an.
+ Geben Sie für JUnit XML **JUnit**(visueller Editor) oder `JUNITXML` (YAML-Editor) an.
+ Geben Sie für NUnit XML **NUnit**(visueller Editor) oder `NUNITXML` (YAML-Editor) an.
+ Geben Sie für NUnit 3-XML **NUnit3**(visueller Editor) oder `NUNIT3XML` (YAML-Editor) an.
+ Geben Sie für Visual Studio TRX **Visual Studio TRX** (visueller Editor) oder `VISUALSTUDIOTRX` (YAML-Editor) an.
+ Geben Sie für TestNG XML **TestNG** (visueller Editor) oder `TESTNGXML` (YAML-Editor) an.
+ Für Berichte zur Codeabdeckung:
+ Geben Sie für Clover-XML **Clover** (visueller Editor) oder `CLOVERXML` (YAML-Editor) an.
+ Geben Sie für Cobertura XML **Cobertura (visueller Editor) oder (YAML-Editor**) an. `COBERTURAXML`
+ Geben Sie für JaCoCo XML **JaCoCo**(visueller Editor) oder `JACOCOXML` (YAML-Editor) an.
+ Geben Sie für SimpleCov JSON, das von [simplecov und nicht von simplecov-json](https://github.com/simplecov-ruby/simplecov) [generiert wurde, Simplecov](https://github.com/vicentllongo/simplecov-json) (visueller Editor) oder (**YAML-Editor**) an. `SIMPLECOV`
+ Für SCA-Berichte (Software Composition Analysis):
+ Geben Sie für SARIF **SARIF** (Visual Editor) oder `SARIFSCA` (YAML-Editor) an.
**Entsprechende Benutzeroberfläche: Gibt den tab/Reports/Manually configure reports/Add *report-name-1* Bericht/ Berichtstyp und das **Berichtsformat** aus**
## Configuration
(*action-name*/**Configuration**)
(Erforderlich) Ein Abschnitt, in dem Sie die Konfigurationseigenschaften der Aktion definieren können.
Entsprechende Benutzeroberfläche: Registerkarte „**Konfiguration**“
## Steps
(*action-name*/Configuration/**Steps**)
(Erforderlich)
Geben Sie Ihren GitHub Aktionscode so an, wie er auf der Detailseite der Aktion im [GitHub Marketplace](https://github.com/marketplace) angezeigt wird. Fügen Sie den Code gemäß den folgenden Richtlinien hinzu:
1. Fügen Sie den Code aus dem `steps:` Abschnitt „ GitHub Aktion“ in den `Steps:` Abschnitt des CodeCatalyst Workflows ein. Der Code beginnt mit einem Bindestrich (-) und sieht wie folgt aus.
GitHub Code zum Einfügen:
```
- name: Lint Code Base
uses: github/super-linter@v4
env:
VALIDATE_ALL_CODEBASE: false
DEFAULT_BRANCH: master
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
1. Überprüfen Sie den Code, den Sie gerade eingefügt haben, und ändern Sie ihn nach Bedarf, sodass er den Standards entspricht CodeCatalyst. **Bei dem vorherigen Codeblock könnten Sie beispielsweise den Code entfernen und den fett *red italics* formatierten Code hinzufügen.**
CodeCatalyst Workflow-Yaml:
```
Steps:
- name: Lint Code Base
uses: github/super-linter@v4
env:
VALIDATE_ALL_CODEBASE: false
DEFAULT_BRANCH: mastermain
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
1. Für zusätzlichen Code, der in der GitHub Aktion enthalten ist, aber nicht im `steps:` Abschnitt vorhanden ist, fügen Sie ihn dem CodeCatalyst Workflow hinzu, indem Sie den Code CodeCatalyst -equivalent verwenden. Sie können den lesen[YAML-Workflow-Definition](workflow-reference.md), um einen Einblick zu erhalten, wie Sie Ihren GitHub Code portieren CodeCatalyst könnten. Detaillierte Migrationsschritte würden den Rahmen dieses Leitfadens sprengen.
Hier ist ein Beispiel für die Angabe von Dateipfaden in einer **GitHub Aktionsaktion**:
```
Steps:
- name: Lint Code Base
uses: github/super-linter@v4
...
- run: cd /sources/WorkflowSource/MyFolder/ && cat file.txt
- run: cd /artifacts/MyGitHubAction/MyArtifact/MyFolder/ && cat file2.txt
```
Weitere Informationen zum Angeben von Dateipfaden finden Sie unter [Quell-Repository-Dateien referenzieren](workflows-sources-reference-files.md) und[Referenzieren von Dateien in einem Artefakt](workflows-working-artifacts-refer-files.md).
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“/„**GitHub Aktionen**“ YAML