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 YAMLWorkflow-Definition.

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+F, 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 (_) 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.

aws/github-actions-runner@v1Für GitHubAktionen verwenden.

Entsprechende Benutzeroberfläche: Workflow-Diagramm/action-name/github-actions-runneraws/ @v1 label

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

Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“/„Hängt davon ab“ — optional

Compute

(action-name/Compute)

(Optional)

Die Rechen-Engine, die zur Ausführung Ihrer Workflow-Aktionen verwendet wurde. 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.

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. Flotteneigenschaften auf Abruf

Bei bereitgestellten Flotten konfigurieren Sie eine Reihe von dedizierten Maschinen, um Ihre Workflow-Aktionen auszuführen. Diese Maschinen bleiben inaktiv und können sofort Aktionen ausführen. Weitere Informationen zu bereitgestellten Flotten finden Sie unter. Bereitgestellte Flotteneigenschaften

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 den Zeitraum in Minuten (YAMLEditor) oder Stunden und Minuten (visueller Editor) an, für den die Aktion ausgeführt werden kann, bevor die Aktion CodeCatalyst beendet wird. Das Minimum beträgt 5 Minuten und das Maximum ist unter beschriebenKontingente für Workflows in CodeCatalyst. 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 zu dem in der ausgewählten Umgebung VPC angegebenen AWS-Konto und optionalen Amazon her. Die Aktion verwendet die in der Umgebung angegebene IAM Standardrolle, um eine Verbindung zum herzustellen AWS-Konto, und verwendet die in der VPCAmazon-Verbindung angegebene IAM Rolle, um eine Verbindung zum Amazon herzustellenVPC.

Anmerkung

Wenn die IAM Standardrolle 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.

Weitere Informationen zu Umgebungen finden Sie unter Einsatz in AWS-Konten und VPCs undErstellen einer Umgebung.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Umgebung“

Name

(action-name/Environment/Name)

(Erforderlich, falls 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 angebenEnvironment.

Wenn Sie keine Kontoverbindung angeben:

Die Aktion verwendet die AWS-Konto Verbindung und die IAM Standardrolle, die in der Umgebung in der CodeCatalyst Konsole angegeben sind. Informationen zum Hinzufügen einer Kontoverbindung und einer IAM Standardrolle zur Umgebung finden Sie unterErstellen einer Umgebung.
Die IAM Standardrolle 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 unterErmöglichen des Zugriffs auf AWS Ressourcen mit verbundenen AWS-Konten. Hinweise zum Hinzufügen einer Kontoverbindung zu einer Umgebung finden Sie unterErstellen einer Umgebung.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /Umgebung/Was ist drin my-environment? /Dreipunktmenü/ Rolle wechseln

Name

(action-name/Environment/Connections/Name)

(Erforderlich, falls enthaltenConnections)

Geben Sie den Namen der Kontoverbindung an.

Entsprechende Benutzeroberfläche: Registerkarte Konfiguration/Umgebung/Was ist drin my-environment? /Dreipunktmenü/ Rolle wechseln

Role

(action-name/Environment/Connections/Role)

(Erforderlich, falls enthaltenConnections)

Geben Sie den Namen der IAM Rolle an, die diese Aktion verwendet, um auf AWS Dienste wie Amazon S3 und Amazon zuzugreifen und diese zu nutzenECR. 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 unterIAMRollen zu Kontoverbindungen hinzufügen.

Wenn Sie keine IAM Rolle angeben, verwendet die Aktion die IAM Standardrolle, die in der Umgebung in der CodeCatalyst Konsole aufgeführt ist. 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-spaceNameRolle für Ihr Konto und Ihren Bereich erstellen. 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: Registerkarte „Konfiguration“ /Umgebung/Was ist drin my-environment? /Dreipunktmenü/ Rolle wechseln

Inputs

(action-name/Inputs)

(Optional)

InputsIn 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.

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 darstelltWorkflowSource, 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.

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 angebenaction-name/Inputs/Sources.

Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unterArtefakte und Dateien zwischen Aktionen teilen.

Anmerkung

Wenn die Dropdownliste Artefakte — optional nicht verfügbar ist (visueller Editor) oder wenn Sie bei der Validierung Ihres YAML (YAMLEditors) Fehler erhalten, kann das daran liegen, 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 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 unterVerwenden von Variablen in Workflows.

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 (_) 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

Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Artefakte

Name

(action-name/Outputs/Artifacts/Name)

(Erforderlich, wenn Artifacts - output es enthalten ist)

Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unter. Artefakte und Dateien zwischen Aktionen teilen

Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Artefakte/Artefakt hinzufügen/Artefaktname erstellen

Files

(action-name/Outputs/Artifacts/Files)

(Artifacts - outputErforderlich, falls enthalten)

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 Siemy-file.jar.
Um eine einzelne Datei in einem Unterverzeichnis anzugeben, verwenden Sie directory/my-file.jar oderdirectory/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 anzugebendirectory, verwenden Sie. "directory/**/*" Das ** Glob-Muster gibt an, dass es einer beliebigen Anzahl von Unterverzeichnissen entspricht.
Um alle Dateien in einem Verzeichnis mit dem Namendirectory, 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

Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unterArtefakte und Dateien zwischen Aktionen teilen.

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 finden Sie unter Quell-Repository-Dateien referenzieren und Referenzieren von Dateien in einem Artefakt.

Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Artefakte/Artefakte hinzufügen/Von build erzeugte Dateien

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 unterVerwenden von Variablen in Workflows.

Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Variablen/Variable hinzufügen

Variablenname-1

(action-name/Outputs/VariablesVariablenname-1)

(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 unterVerwenden von Variablen in Workflows.

Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Variablen/Variable hinzufügen/Name

AutoDiscoverReports

(action-name/Outputs/AutoDiscoverReports)

(Optional)

Definiert die Konfiguration für die automatische Erkennungsfunktion.

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 Software-Kompositionsanalyseberichten (SCA) 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 oder 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 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 undTestSuiteTwo.xml. AutoDiscoveredTestSuiteTwo

Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Berichte automatisch/Berichte automatischen/Berichtspräfix

IncludePaths

(action-name/Outputs/AutoDiscoverReports/IncludePaths)

Oder

(action-name/Outputs/Reports/report-name-1/IncludePaths)

(Erforderlich, wenn AutoDiscoverReports es enthalten und aktiviert ist, oder wenn es enthalten ist) Reports

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, 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

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:

Registerkarte „Ausgaben/Berichte“ /Berichte automatisch erkennen/„ Pfade einschließen/ausschließen“/Pfade einschließen
Registerkarte „Ausgaben/Berichte/Berichte manuell konfigurieren/report-name-1/'Pfade einschließen/ausschließen'/ Pfade 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 CodeCatalyst ausgeschlossen werden sollen. 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

Entsprechende Benutzeroberfläche:

Registerkarte „Ausgaben/Berichte“ /Berichte automatisch erkennen/„ Pfade einschließen/ausschließen“/Pfade ausschließen
Registerkarte „Ausgaben/Berichte/Berichte manuell konfigurieren/report-name-1/'Pfade einschließen/ausschließen'/ Pfade ausschließen

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, Softwarekompositionsanalyse (SCA) und statische Analyse (SA) an.

Weitere Informationen finden Sie unter Erfolgskriterien für Berichte konfigurieren.

Entsprechende Benutzeroberfläche:

Registerkarte „Ausgaben/Berichte“ /Berichte automatisch entdecken/Erfolgskriterien
Registerkarte „Ausgaben/Berichte/Berichte manuell konfigurieren/report-name-1/Erfolgskriterien

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 unterTestberichte.

Entsprechende Benutzeroberfläche:

Registerkarte „Ausgaben/Berichte automatisch entdecken/Erfolgskriterien“/Erfolgsquote
Registerkarte „Ausgaben/Berichte/Berichte manuell konfigurieren/report-name-1/Erfolgskriterien/ Erfolgsquote

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 zur Codeabdeckung an, die abgedeckt sein 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 Leitungsabdeckung werden nur auf Berichte zur Codeabdeckung angewendet. Weitere Informationen zu Berichten über die Codeabdeckung finden Sie unterBerichte zur Codeabdeckung.

Entsprechende Benutzeroberfläche:

Registerkarte „Ausgaben/Berichte automatisch entdecken/Erfolgskriterien“/„Leitungsabdeckung“
Registerkarte „Ausgaben/Berichte/Berichte manuell konfigurieren/report-name-1/Erfolgskriterien/ Leitungsabdeckung

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 über die 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 unterBerichte zur Codeabdeckung.

Entsprechende Benutzeroberfläche:

Registerkarte „Ausgaben/Berichte automatisch entdecken/Erfolgskriterien“ /Abdeckung der Filialen
Registerkarte Ausgaben/Berichte/Berichte manuell konfigurieren/report-name-1/Erfolgskriterien/Reichweite 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: CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.

Wenn Sie beispielsweise wählen HIGHHIGH, 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 unterBerichte zur Analyse der Softwarezusammensetzung.

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 unterTypen von Qualitätsberichten.

Entsprechende Benutzeroberfläche:

Registerkarte „Ausgaben/Berichte automatisch entdecken/Erfolgskriterien“/Sicherheitslücken
Registerkarte Ausgaben/Berichte/Berichte manuell konfigurieren/report-name-1/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

(action-name/Outputs/Reports/Berichtsname-1)

(Erforderlich, falls enthalten) Reports

Der Name, den Sie dem CodeCatalyst Bericht geben möchten, der aus Ihren Rohberichten generiert wird.

Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Berichte/Berichte manuell konfigurieren/Berichtsname

Format

(action-name/Outputs/Reports/report-name-1/Format)

(Erforderlich, falls enthalten) 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 JSON Cucumber Cucumber (visueller Editor) oder CUCUMBERJSON (YAMLEditor) an.
- Geben Sie für JUnit XML JUnit(visueller Editor) oder JUNITXML (YAMLEditor) an.
- Geben Sie für NUnit XML NUnit(visueller Editor) oder NUNITXML (YAMLEditor) an.
- Geben Sie für NUnit 3 XML NUnit3(visueller Editor) oder NUNIT3XML (YAMLEditor) an.
- Geben Sie für Visual Studio TRX Visual Studio TRX (visueller Editor) oder VISUALSTUDIOTRX (YAMLEditor) an.
- Geben Sie für TestNG XML TestNG (visueller Editor) oder TESTNGXML (YAMLEditor) an.
Für Berichte über die Codeabdeckung:
- Geben Sie für Clover XML Clover (visueller Editor) oder CLOVERXML (YAMLEditor) an.
- Geben Sie für Cobertura XML Cobertura (visueller Editor) oder (Editor) an. COBERTURAXML YAML
- Geben Sie für JaCoCo XML JaCoCo(visueller Editor) oder JACOCOXML (Editor) an. YAML
- Geben Sie für „Von simplecov SimpleCov JSON generiert“ und nicht „simplecov-json“ Simplecov (visueller Editor) oder (Editor) an. SIMPLECOV YAML
Für Berichte SCA zur Analyse der Softwarezusammensetzung ():
- Geben Sie für SARIF SARIF(visueller Editor) oder SARIFSCA (YAMLEditor) an.

Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Berichte/Berichte manuell konfigurieren/Bericht hinzufügen/report-name-1/Berichtstyp und Berichtsformat

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 angezeigt wird. Füge den Code gemäß diesen Richtlinien hinzu:

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 }}
```
Überprüfen Sie den Code, den Sie gerade eingefügt haben, und ändern Sie ihn nach Bedarf, sodass er den Standards entspricht CodeCatalyst. Mit dem vorherigen Codeblock könnten Sie beispielsweise den Code in entfernen red italics, und fügen Sie den Code fett hinzu.

CodeCatalyst Arbeitsablauf Yaml:
```
Steps:      
   - name: Lint Code Base
     uses: github/super-linter@v4
     env:
       VALIDATE_ALL_CODEBASE: false
       DEFAULT_BRANCH: mastermain
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
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 lesenYAMLWorkflow-Definition, um einen Einblick zu erhalten, wie Sie Ihren GitHub Code portieren CodeCatalyst könnten. Detaillierte Migrationsschritte würden den Rahmen dieses Handbuchs 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 undReferenzieren von Dateien in einem Artefakt.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/AktionenGitHub “ YAML

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Referenzieren von GitHub Ausgabeparametern

Konfiguration von Rechen- und Runtime-Images