Amazon CodeCatalyst ist nicht mehr offen für neue Kunden. Bestandskunden können den Service weiterhin wie gewohnt nutzen. Weitere Informationen finden Sie unter Wie migriert man von CodeCatalyst.
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.
Aktionen erstellen und testen YAML
Im Folgenden finden Sie die YAML-Definition der Build- und Testaktionen. Es gibt eine Referenz für zwei Aktionen, da ihre YAML-Eigenschaften sehr ähnlich sind.
Diese Aktionsdefinition existiert als Abschnitt in einer umfassenderen Workflow-Definitionsdatei. Weitere Informationen über diese Datei finden Sie unter Definition von Workflow-YAML.
Wählen Sie im folgenden Code eine YAML-Eigenschaft aus, um eine Beschreibung dieser Eigenschaft anzuzeigen.
Anmerkung
Die meisten der folgenden YAML-Eigenschaften haben entsprechende UI-Elemente im visuellen Editor. Verwenden Sie Strg+F, um ein UI-Element nachzuschlagen. Das Element wird mit der zugehörigen YAML-Eigenschaft aufgelistet.
# The workflow definition starts here.
# See Top-level Eigenschaften for details.
Name: MyWorkflow
SchemaVersion: 1.0
Actions:
# The action definition starts here.
action-name:
Identifier: aws/build@v1 | aws/managed-test@v1
DependsOn:
- dependent-action-name-1
Compute:
Type: EC2 | Lambda
Fleet: fleet-name
Timeout: timeout-minutes
Environment:
Name: environment-name
Connections:
- Name: account-connection-name
Role: iam-role-name
Caching:
FileCaching:
key-name-1:
Path: file1.txt
RestoreKeys:
- restore-key-1
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:
- build-output/artifact-1.jar
- "build-output/build*"
- Name: output-artifact-2
Files:
- build-output/artifact-2.1.jar
- build-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
StaticAnalysisBug:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisSecurity:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisQuality:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisFinding:
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
StaticAnalysisBug:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisSecurity:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisQuality:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
StaticAnalysisFinding:
Severity: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL
Number: whole-number
Configuration:
Container:
Registry: registry
Image: image
Steps:
- Run: "step 1"
- Run: "step 2"
Packages:
NpmConfiguration:
PackageRegistries:
- PackagesRepository: package-repository
Scopes:
- "@scope"
ExportAuthorizationToken: true | false
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, 0-9) A-Z, Bindestriche (-) und Unterstriche (_) beschränkt. Leerzeichen sind nicht erlaubt. Sie können keine Anführungszeichen verwenden, um Sonderzeichen und Leerzeichen in Aktionsnamen zu aktivieren.
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Aktionsname“
Kennung
(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.
Wird aws/build@v1 für Build-Aktionen verwendet.
Wird aws/managed-test@v1 für Testaktionen verwendet.
Entsprechende Benutzeroberfläche: diagram/Action Workflow-Name/ Bezeichnung aws/build@v1|aws/managed-test@v1
DependsOn
(action-name/DependsOn)
(Optional)
Geben Sie eine Aktion, eine Aktionsgruppe oder ein Gate an, die erfolgreich ausgeführt werden muss, damit diese Aktion ausgeführt werden kann.
Weitere Hinweise zur Funktion „abhängig von“ finden Sie unter. Aktionen sequenzieren
Entsprechende Benutzeroberfläche: Registerkarte Eingaben/Hängt davon ab — optional
Datenverarbeitung
(action-name/Compute)
(Optional)
Die Rechenmaschine, mit der Ihre Workflow-Aktionen ausgeführt werden. Sie können Compute entweder auf Workflow-Ebene oder auf Aktionsebene angeben, aber nicht auf beiden. Wenn die Compute-Konfiguration auf Workflow-Ebene angegeben wird, gilt sie 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
Typ
(action-name/Compute/Typ)
(DatenverarbeitungErforderlich, falls enthalten)
Der Typ der Rechenmaschine. Sie können einen der folgenden Werte verwenden:
-
EC2 (visueller Editor) oder
EC2(YAML-Editor)Optimiert für Flexibilität bei Aktionsausführungen.
-
Lambda (visueller Editor) oder
Lambda(YAML-Editor)Optimierte Startgeschwindigkeiten für Aktionen.
Weitere Informationen zu Datentypen finden Sie unter Typen berechnen.
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Berechnungstyp“
Flotte
(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 beim Start 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. On-demand Eigenschaften der Flotte
Bei bereitgestellten Flotten konfigurieren Sie eine Reihe von dedizierten Maschinen, auf denen Ihre Workflow-Aktionen ausgeführt werden. Diese Maschinen bleiben im Leerlauf und sind bereit, Aktionen sofort zu verarbeiten. Weitere Informationen zu bereitgestellten Flotten finden Sie unter. Eigenschaften von bereitgestellten Flotten
Wenn Fleet es weggelassen wird, ist die Standardeinstellung. Linux.x86-64.Large
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Flotte berechnen“
Zeitüberschreitung
(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 wird unter beschriebenKontingente für Workflows in CodeCatalyst. Das Standard-Timeout entspricht dem maximalen Timeout.
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Timeout“ — optional
Umgebung
(action-name/Environment)
(Optional)
Geben Sie die CodeCatalyst Umgebung an, die mit der Aktion verwendet werden soll. Die Aktion stellt eine Verbindung zu der AWS-Konto und der optionalen Amazon VPC her, die in der ausgewählten Umgebung angegeben ist. Die Aktion verwendet die in der Umgebung angegebene Standard-IAM-Rolle, um eine Verbindung mit der herzustellen AWS-Konto, und verwendet die in der Amazon VPC-Verbindung angegebene IAM-Rolle, um eine Verbindung zur Amazon VPC 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 Änderung der IAM-Rolle einer Aktion.
Weitere Informationen zu Umgebungen finden Sie unter Bereitstellung in AWS-Konten und VPCs undErstellen einer Umgebung.
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Umgebung“
Name
(action-name/Environment/Name)
(Optional)
Geben Sie den Namen einer vorhandenen Umgebung an, die Sie der Aktion zuordnen möchten.
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Umgebung“
Verbindungen
(action-name/Environment/Connections)
(Optional)
Geben Sie die Kontoverbindung an, die der Aktion zugeordnet werden soll. Unter können Sie maximal eine Kontoverbindung angebenEnvironment.
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
-
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 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: Konfiguration tab/Environment /Was ist drinmy-environment? /Dreipunktmenü/ Rolle wechseln
Name
(action-name/Environment/Connections/Name)
(Erforderlich, falls enthaltenVerbindungen)
Geben Sie den Namen der Kontoverbindung an.
Entsprechende Benutzeroberfläche: Konfiguration tab/Environment /Was ist drinmy-environment? /Dreipunktmenü/ Rolle wechseln
Rolle
(action-name/Environment/Connections/Role)
(Erforderlich, falls enthaltenVerbindungen)
Geben Sie den Namen der IAM-Rolle an, die diese Aktion verwendet, um auf AWS Dienste wie Amazon S3 und Amazon ECR zuzugreifen und in diesen zu arbeiten. 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 unterHinzufügen von IAM-Rollen zu Kontoverbindungen.
Wenn Sie keine IAM-Rolle angeben, verwendet die Aktion die Standard-IAM-Rolle, die in der Umgebung in der Konsole aufgeführt ist. CodeCatalyst Wenn Sie die Standardrolle in der Umgebung verwenden, stellen Sie sicher, dass sie die folgenden Richtlinien erfüllt.
Anmerkung
Sie können die CodeCatalystWorkflowDevelopmentRole- Rolle mit dieser Aktion verwenden. Weitere Informationen über diese Rolle finden Sie unter Die CodeCatalystWorkflowDevelopmentRole-spaceNameRolle für Ihr Konto und Ihren Bereich erstellen. Machen Sie sich bewusst, dass die spaceNameCodeCatalystWorkflowDevelopmentRole- Rolle über vollständige 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. spaceName
Warnung
Beschränken Sie die Berechtigungen auf die Berechtigungen, die für die Build- und Testaktionen erforderlich sind. Die Verwendung einer Rolle mit umfassenderen Berechtigungen kann ein Sicherheitsrisiko darstellen.
Entsprechende Benutzeroberfläche: Konfiguration tab/Environment /Was ist drinmy-environment? /Dreipunktmenü/ Rolle wechseln
Caching
(action-name/Caching)
(Optional)
Ein Abschnitt, in dem Sie einen Cache angeben können, um Dateien auf der Festplatte zu speichern und sie in nachfolgenden Workflow-Ausführungen aus diesem Cache wiederherzustellen.
Weitere Informationen zum Zwischenspeichern von Dateien finden Sie unter. Zwischenspeichern von Dateien zwischen Workflow-Läufen
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Datei-Caching“ — optional
FileCaching
(action-name/Caching/FileCaching)
(Optional)
Ein Abschnitt, der die Konfiguration für eine Abfolge von Caches spezifiziert.
Entsprechende Benutzeroberfläche: tab/File Konfigurations-Caching — optional/Cache hinzufügen
Schlüsselname-1
(action-name/Caching/FileCaching/key-name-1)
(Optional)
Geben Sie den Namen Ihrer primären Cache-Eigenschaft an. Die Namen der Cache-Eigenschaften müssen innerhalb Ihres Workflows eindeutig sein. Jede Aktion kann bis zu fünf Einträge enthaltenFileCaching.
Entsprechende Benutzeroberfläche: tab/File Konfigurations-Caching — optional/Add Cache/Key
Pfad
(action-name/Caching/FileCaching/key-name-1/Path)
(Optional)
Geben Sie den zugehörigen Pfad für Ihren Cache an.
Entsprechende Benutzeroberfläche: tab/File Konfigurations-Caching - optional/Add Cache/ Path
RestoreKeys
(action-name/Caching/FileCaching/key-name-1/RestoreKeys)
(Optional)
Geben Sie den Wiederherstellungsschlüssel an, der als Fallback verwendet werden soll, wenn die primäre Cache-Eigenschaft nicht gefunden werden kann. Die Namen der Wiederherstellungsschlüssel müssen innerhalb Ihres Workflows eindeutig sein. Jeder Cache kann bis zu fünf Einträge enthaltenRestoreKeys.
Entsprechende Benutzeroberfläche: tab/File Konfigurations-Caching — optional/Add Cache/Schlüssel wiederherstellen — optional
Eingaben
(action-name/Inputs)
(Optional)
Der Inputs Abschnitt definiert die Daten, die eine Aktion während einer Workflow-Ausführung benötigt.
Anmerkung
Pro Build-Aktion oder Testaktion sind maximal vier Eingaben (eine Quelle und drei Artefakte) zulässig. Variablen zählen nicht zu dieser Summe.
Wenn Sie auf Dateien verweisen müssen, die sich in verschiedenen 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 erhalten ein spezielles Präfix, um sie von der primären zu unterscheiden. Details hierzu finden Sie unter Beispiel: Referenzieren von Dateien in mehreren Artefakten.
Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“
Quellen
(action-name/Inputs/Sources)
(Optional)
Geben Sie die Bezeichnungen für die Quell-Repositorys an, die für die Aktion benötigt werden. Derzeit wird nur das Label unterstütztWorkflowSource, das das Quell-Repository darstellt, in dem Ihre Workflow-Definitionsdatei gespeichert ist.
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: keine
Artefakte - Eingabe
(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 Eingabe-Artefakte angeben, müssen Sie mindestens ein Quell-Repository unter angeben.action-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 (YAML-Editor) eine Fehlermeldung 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
Variablen — Eingabe
(action-name/Inputs/Variables)
(Optional)
Geben Sie eine Folge 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, 0-9) A-Z, Bindestriche (-) und Unterstriche (_) beschränkt. Leerzeichen sind nicht erlaubt. Sie können keine Anführungszeichen verwenden, um Sonderzeichen und Leerzeichen in Variablennamen zu aktivieren.
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“
Artefakte — Ausgabe
(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 Ausgabeartefaktnamen zu aktivieren.
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, falls Artefakte — Ausgabe enthalten)
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 Ausgabeartefaktnamen zu aktivieren.
Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unter. Artefakte und Dateien zwischen Aktionen teilen
Entsprechende Benutzeroberfläche: Ausgaben tab/Artifacts /Neue Ausgabe/ Name des Artefakts erstellen
Dateien
(action-name/Outputs/Artifacts/Files)
(Erforderlich, falls enthaltenArtefakte — Ausgabe)
Geben Sie die Dateien an, die in dem Artefakt CodeCatalyst enthalten sind, das von der Aktion ausgegeben wird. Diese Dateien werden von der 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 in einem Artefakt aus einer vorherigen Aktion befinden und beziehen sich auf das Quell-Repository oder den 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-Repositorys befindet, verwenden Sie
my-file.jar. -
Um eine einzelne Datei in einem Unterverzeichnis anzugeben, verwenden Sie
directory/my-file.jaroderdirectory/subdirectory/my-file.jar. -
Um alle Dateien anzugeben, verwenden Sie
"**/*". Das**Glob-Muster gibt an, dass es einer beliebigen Anzahl von Unterverzeichnissen entsprechen soll. -
Um alle Dateien und Verzeichnisse in einem Verzeichnis mit dem Namen anzugeben
directory, verwenden Sie."directory/**/*"Das**Glob-Muster gibt an, dass eine beliebige Anzahl von Unterverzeichnissen übereinstimmen soll. -
Um alle Dateien in einem benannten Verzeichnis anzugeben
directory, aber keines seiner Unterverzeichnisse, 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 Informationen 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 es zu finden ist. Weitere Informationen erhalten Sie unter Quell-Repository-Dateien referenzieren und Referenzieren von Dateien in einem Artefakt.
Entsprechende Benutzeroberfläche: Outputs tab/Artifacts /New Output/ Von Build erzeugte Dateien
Variablen — Ausgabe
(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: Ausgaben tab/Variables/Variable hinzufügen
Variablenname-1
(action-name/Outputs/Variables/variable-name-1)
(Optional)
Geben Sie den Namen einer Variablen an, die die Aktion exportieren soll. Diese Variable muss bereits im Steps Abschnitt Inputs oder derselben Aktion definiert sein.
Weitere Hinweise zu Variablen, einschließlich Beispielen, finden Sie unterVerwenden von Variablen in Workflows.
Entsprechende Benutzeroberfläche: Ausgaben tab/Variables /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 Dateien sowie alle von der Aktion selbst generierten Dateien CodeCatalyst durchsucht. Dabei wird nach Berichten zu Tests, Codeabdeckung und Softwarekompositionsanalyse (SCA) gesucht. Für jeden gefundenen Bericht wird dieser in einen CodeCatalyst Bericht umgewandelt. CodeCatalyst Ein CodeCatalyst Bericht ist ein Bericht, der vollständig in den CodeCatalyst Dienst integriert ist und über die Konsole angezeigt und bearbeitet werden kann. CodeCatalyst
Anmerkung
Standardmäßig überprüft die Funktion zur automatischen Erkennung alle Dateien. Mithilfe der Eigenschaften IncludePaths oder ExcludePaths können Sie einschränken, welche Dateien überprüft werden.
Entsprechende Benutzeroberfläche: Ausgaben tab/Reports/Auto-discoverBerichte
Aktiviert
(action-name/Outputs/AutoDiscoverReports/Enabled)
(Optional)
Aktivieren oder deaktivieren Sie die Funktion zur automatischen Erkennung.
Gültige Werte sind true oder false.
Wenn Enabled es weggelassen wird, ist true die Standardeinstellung.
Entsprechende Benutzeroberfläche: Ausgaben tab/Reports/Auto-discoverBerichte
ReportNamePrefix
(action-name/Outputs/AutoDiscoverReports/ReportNamePrefix)
(AutoDiscoverReportsErforderlich, wenn enthalten und aktiviert)
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 und angeben und CodeCatalyst automatisch zwei Testberichte und erkannt werden, erhalten die zugehörigen CodeCatalyst Berichte den Namen TestSuiteOne.xml undTestSuiteTwo.xml. AutoDiscovered AutoDiscoveredTestSuiteOne AutoDiscoveredTestSuiteTwo
Entsprechende Benutzeroberfläche: Ausgaben tab/Reports//Präfixname
IncludePaths
(action-name/Outputs/AutoDiscoverReports/IncludePaths)
Oder
(action-name/Outputs/Reports/report-name-1/IncludePaths)
(Erforderlich, wenn enthalten und aktiviert AutoDiscoverReports ist oder wenn enthalten Berichte ist)
Geben Sie die Dateien und Dateipfade an, CodeCatalyst die bei der Suche nach Rohberichten berücksichtigt werden. Wenn Sie beispielsweise angeben"/test/report/*", CodeCatalyst durchsucht das gesamte Build-Image, das von der Aktion verwendet wird, um nach dem /test/report/* Verzeichnis zu suchen. 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 Informationen zu Sonderzeichen finden Sie unter. Richtlinien und Konventionen zur Syntax
Wenn diese Eigenschaft weggelassen wird, lautet 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:
-
Ausgaben tab/Reports/Auto-discover reports/Include/Pfade ausschließen/ Pfade einbeziehen
-
Ausgaben tab/Reports /Berichte
report-name-1manuell konfigurieren//Pfade/ Pfade einbeziehen Include/exclude
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 CodeCatalyst Rohberichten ausgeschlossen werden. Wenn Sie dies beispielsweise angeben"/test/my-reports/**/*", CodeCatalyst wird im /test/my-reports/ Verzeichnis nicht nach Dateien gesucht. Verwenden Sie das **/* Glob-Muster, um alle Dateien in einem Verzeichnis zu ignorieren.
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 unterRichtlinien und Konventionen zur Syntax.
Entsprechende Benutzeroberfläche:
-
Ausgaben tab/Reports/Auto-discover reports/Include/Pfade ausschließen/ Pfade ausschließen
-
Ausgaben tab/Reports /Berichte
report-name-1manuell konfigurieren//Pfade/ Pfade ausschließen Include/exclude
SuccessCriteria
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria)
Oder
(action-name/Outputs/Reports/report-name-1/SuccessCriteria)
(Optional)
Geben Sie die Erfolgskriterien für den Test, die Codeabdeckung, die Softwarezusammenstellungsanalyse (SCA) und die statische Analyse (SA) an.
Weitere Informationen finden Sie unter Erfolgskriterien für Berichte konfigurieren.
Entsprechende Benutzeroberfläche: Ausgabe tab/Reports/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. Gültige Werte beinhalten Dezimalzahlen. Zum Beispiel: 50, 60.5. Die Kriterien für die Erfolgsquote gelten nur für Testberichte. Weitere Informationen zu Testberichten finden Sie unterTestberichte.
Entsprechende Benutzeroberfläche: Ausgabe tab/Reports /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 zur Codeabdeckung finden Sie unterCode-Abdeckungsberichte.
Entsprechende Benutzeroberfläche: Ausgabe tab/Reports /Erfolgskriterien/ Zeilenabdeckung
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 Codeabdeckungsbericht 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 Filialabdeckung werden nur auf Berichte zur Codeabdeckung angewendet. Weitere Informationen zu Berichten zur Codeabdeckung finden Sie unterCode-Abdeckungsberichte.
Entsprechende Benutzeroberfläche: Ausgabe tab/Reports /Erfolgskriterien/ Branch-Abdeckung
Schwachstellen
(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 Sicherheitslücken, die Sie in die Anzahl 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 alleCRITICALSicherheitslücken gezählt. -
Die maximale Anzahl von Sicherheitslücken mit dem angegebenen Schweregrad, die Sie zulassen möchten. Wird diese Zahl überschritten, 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 Softwarekomposition.
Verwenden Sie die Severity Eigenschaft, um den Mindestschweregrad anzugeben. Verwenden Sie die Number Eigenschaft, um die maximale Anzahl von Sicherheitslücken anzugeben.
Entsprechende Benutzeroberfläche: Ausgabe tab/Reports /Erfolgskriterien/ Sicherheitslücken
StaticAnalysisBug
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisBug)
Oder
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisBug)
(Optional)
Geben Sie die maximale Anzahl und den Schweregrad der Fehler an, die im SA-Bericht zulässig sind, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Um Fehler zu spezifizieren, müssen Sie Folgendes angeben:
-
Der Mindestschweregrad der Fehler, 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 zum Beispiel wählen
HIGHHIGH, werdenCRITICALFehler gezählt. -
Die maximale Anzahl von Bugs mit dem angegebenen Schweregrad, die Sie zulassen möchten. Wird diese Zahl überschritten, wird der CodeCatalyst Bericht als fehlgeschlagen markiert. Gültige Werte sind ganze Zahlen.
Die Kriterien für Fehler werden nur auf PyLint Berichte von ESLint SA angewendet. Weitere Informationen zu SA-Berichten finden Sie unterStatische Analyseberichte.
Verwenden Sie die Severity Eigenschaft, um den Mindestschweregrad anzugeben. Verwenden Sie die Number Eigenschaft, um die maximale Anzahl von Sicherheitslücken anzugeben.
Entsprechende Benutzeroberfläche: Ausgabe tab/Reports /Erfolgskriterien/ Bugs
StaticAnalysisSecurity
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisSecurity)
Oder
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisSecurity)
(Optional)
Geben Sie die maximale Anzahl und den Schweregrad der Sicherheitslücken an, die im SA-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 Sicherheitslücken, die Sie in die Anzahl einbeziehen möchten. Gültige Werte (vom höchsten bis zum geringsten Schweregrad) sind:
CRITICALHIGH,MEDIUM,,LOW,INFORMATIONAL.Wenn Sie beispielsweise wählen
HIGH, werdenHIGHalleCRITICALSicherheitslücken gezählt. -
Die maximale Anzahl von Sicherheitslücken mit dem angegebenen Schweregrad, die Sie zulassen möchten. Wird diese Zahl überschritten, wird der CodeCatalyst Bericht als fehlgeschlagen markiert. Gültige Werte sind ganze Zahlen.
Die Kriterien für Sicherheitslücken werden nur auf PyLint Berichte von ESLint SA angewendet. Weitere Informationen zu SA-Berichten finden Sie unterStatische Analyseberichte.
Verwenden Sie die Severity Eigenschaft, um den Mindestschweregrad anzugeben. Verwenden Sie die Number Eigenschaft, um die maximale Anzahl von Sicherheitslücken anzugeben.
Entsprechende Benutzeroberfläche: Ausgabe tab/Reports /Erfolgskriterien/ Sicherheitslücken
StaticAnalysisQuality
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisQuality)
Oder
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisQuality)
(Optional)
Geben Sie die maximale Anzahl und den Schweregrad der Qualitätsprobleme an, die im Sicherheitsbericht zulässig sind, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Um Qualitätsprobleme zu spezifizieren, müssen Sie Folgendes angeben:
-
Der Mindestschweregrad der Qualitätsprobleme, 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, werdenCRITICALQualitätsprobleme gezählt. -
Die maximale Anzahl von Qualitätsproblemen mit dem angegebenen Schweregrad, die Sie zulassen möchten. Wird diese Zahl überschritten, wird der CodeCatalyst Bericht als nicht erfolgreich markiert. Gültige Werte sind ganze Zahlen.
Die Kriterien für Qualitätsprobleme werden nur auf PyLint Berichte von ESLint SA angewendet. Weitere Informationen zu SA-Berichten finden Sie unterStatische Analyseberichte.
Verwenden Sie die Severity Eigenschaft, um den Mindestschweregrad anzugeben. Verwenden Sie die Number Eigenschaft, um die maximale Anzahl von Sicherheitslücken anzugeben.
Entsprechende Benutzeroberfläche: Ausgabe tab/Reports /Erfolgskriterien/ Qualitätsprobleme
StaticAnalysisFinding
(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/StaticAnalysisFinding)
Oder
(action-name/Outputs/Reports/report-name-1/SuccessCriteria/StaticAnalysisFinding)
(Optional)
Geben Sie die maximale Anzahl und den Schweregrad der Ergebnisse an, die im SA-Bericht zulässig sind, damit der zugehörige CodeCatalyst Bericht als bestanden markiert wird. Um die Ergebnisse zu spezifizieren, müssen Sie Folgendes angeben:
-
Der Mindestschweregrad der Ergebnisse, 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
HIGH, werdenHIGHdieCRITICALErgebnisse zusammengezählt. -
Die maximale Anzahl von Ergebnissen mit dem angegebenen Schweregrad, die Sie zulassen möchten. Wird diese Zahl überschritten, wird der CodeCatalyst Bericht als nicht erfolgreich markiert. Gültige Werte sind ganze Zahlen.
Die Ergebnisse werden nur auf Berichte von SARIF SA angewendet. Weitere Informationen zu SA-Berichten finden Sie unterStatische Analyseberichte.
Verwenden Sie die Severity Eigenschaft, um den Mindestschweregrad anzugeben. Verwenden Sie die Number Eigenschaft, um die maximale Anzahl von Sicherheitslücken anzugeben.
Entsprechende Benutzeroberfläche: Ausgabe tab/Reports /Erfolgskriterien/Ergebnisse
Berichte
(action-name/Outputs/Reports )
(Optional)
Ein Abschnitt, der die Konfiguration für Testberichte spezifiziert.
Entsprechende Benutzeroberfläche: Registerkarte Ausgänge/Berichte
Berichtsname-1
(Berichtsname-1) action-name /Outputs/Reports/
(Erforderlich, falls enthalten) Berichte
Der Name, den Sie dem CodeCatalyst Bericht geben möchten, der aus Ihren Rohberichten generiert wird.
Entsprechende Benutzeroberfläche: Ausgaben tab/Reports /Berichte manuell konfigurieren/ Berichtsname
Format
(action-name/Outputs/Reports/report-name-1/Format)
(Erforderlich, falls enthaltenBerichte)
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 (YAML-Editor) an.
NUNIT3XML -
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 generiert wurde
, nicht simplecov-json, Simplecov (visueller Editor) oder (YAML-Editor) an. SIMPLECOV
-
-
Für Berichte zur Softwarezusammensetzungsanalyse (SCA):
-
Geben Sie für SARIF SARIF (visueller Editor) oder
SARIFSCA(YAML-Editor) an.
-
Entsprechende Benutzeroberfläche: Ausgaben tab/Reports /Berichte manuell reports/Add konfigurieren//Berichtstyp und Berichtsformat report-name-1
Konfiguration
(action-name/Configuration)
(Erforderlich) Ein Abschnitt, in dem Sie die Konfigurationseigenschaften der Aktion definieren können.
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“
Behälter
(action-name/Configuration/Container)
(Optional)
Geben Sie das Docker-Image oder den Container an, den die Aktion verwendet, um ihre Verarbeitung abzuschließen. Sie können eines der mitgelieferten aktiven Images angeben CodeCatalyst, oder Sie können Ihr eigenes Image verwenden. Wenn Sie Ihr eigenes Image verwenden möchten, kann es sich in Amazon ECR, Docker Hub oder einer anderen Registry befinden. Wenn Sie kein Docker-Image angeben, verwendet die Aktion eines der aktiven Images für die Verarbeitung. Informationen darüber, welches aktive Image standardmäßig verwendet wird, finden Sie unterAktive Bilder.
Weitere Informationen zur Angabe Ihres eigenen Docker-Images finden Sie unterZuweisen eines Docker-Images für eine benutzerdefinierte Laufzeitumgebung zu einer Aktion.
Entsprechende Benutzeroberfläche: Docker-Image für die Laufzeitumgebung — optional
Registrierung
(action-name/Configuration/Container/Registry)
(Erforderlich, falls Container enthalten)
Geben Sie die Registrierung an, in der Ihr Bild gespeichert ist. Gültige Werte sind:
-
CODECATALYST(YAML-Editor)Das Bild wird in der CodeCatalyst Registrierung gespeichert.
-
Docker Hub (visueller Editor) oder
DockerHub(YAML-Editor)Das Image wird in der Docker Hub-Image-Registrierung gespeichert.
-
Andere Registrierung (visueller Editor) oder
Other(YAML-Editor)Das Bild wird in einer benutzerdefinierten Image-Registrierung gespeichert. Jedes öffentlich zugängliche Register kann verwendet werden.
-
Amazon Elastic Container Registry (visueller Editor) oder
ECR(YAML-Editor)Das Image wird in einem Amazon Elastic Container Registry Image-Repository gespeichert. Um ein Bild in einem Amazon ECR-Repository zu verwenden, benötigt diese Aktion Zugriff auf Amazon ECR. Um diesen Zugriff zu aktivieren, müssen Sie eine IAM-Rolle erstellen, die die folgenden Berechtigungen und eine benutzerdefinierte Vertrauensrichtlinie umfasst. (Sie können eine vorhandene Rolle ändern, um die Berechtigungen und Richtlinien einzubeziehen, wenn Sie möchten.)
Die IAM-Rolle muss die folgenden Berechtigungen in ihrer Rollenrichtlinie enthalten:
-
ecr:BatchCheckLayerAvailability -
ecr:BatchGetImage -
ecr:GetAuthorizationToken -
ecr:GetDownloadUrlForLayer
Die IAM-Rolle muss die folgende benutzerdefinierte Vertrauensrichtlinie enthalten:
Weitere Informationen zum Erstellen von IAM-Rollen finden Sie unter Erstellen einer Rolle mithilfe benutzerdefinierter Vertrauensrichtlinien (Konsole) im IAM-Benutzerhandbuch.
Nachdem Sie die Rolle erstellt haben, müssen Sie sie der Aktion über eine Umgebung zuweisen. Weitere Informationen finden Sie unter Eine Umgebung mit einer Aktion verknüpfen.
-
Entsprechende Benutzeroberfläche: Amazon Elastic Container Registry, Docker Hub und andere Registrierungsoptionen
Image
(action-name/Configuration/Container/Image)
(Erforderlich, falls Container enthalten)
Geben Sie eines der folgenden Elemente an:
-
Wenn Sie eine
CODECATALYSTRegistrierung verwenden, stellen Sie das Image auf eines der folgenden aktiven Images ein:-
CodeCatalystLinux_x86_64:2024_03 -
CodeCatalystLinux_x86_64:2022_11 -
CodeCatalystLinux_Arm64:2024_03 -
CodeCatalystLinux_Arm64:2022_11 -
CodeCatalystLinuxLambda_x86_64:2024_03 -
CodeCatalystLinuxLambda_x86_64:2022_11 -
CodeCatalystLinuxLambda_Arm64:2024_03 -
CodeCatalystLinuxLambda_Arm64:2022_11 -
CodeCatalystWindows_x86_64:2022_11
-
-
Wenn Sie eine Docker Hub-Registrierung verwenden, setzen Sie das Image auf den Docker-Hub-Image-Namen und das optionale Tag.
Beispiel:
postgres:latest -
Wenn Sie eine Amazon ECR-Registrierung verwenden, legen Sie für das Image die Amazon ECR-Registrierungs-URI fest.
Beispiel:
111122223333.dkr.ecr.us-west-2.amazonaws.com/codecatalyst-ecs-image-repo -
Wenn Sie eine benutzerdefinierte Registrierung verwenden, setzen Sie das Bild auf den Wert, der von der benutzerdefinierten Registrierung erwartet wird.
Entsprechende Benutzeroberfläche: Docker-Image der Laufzeitumgebung (falls es sich bei der Registrierung um eine Registrierung handeltCODECATALYST), Docker-Hub-Image (wenn die Registrierung Docker Hub ist), ECR-Image-URL (wenn es sich bei der Registrierung um Amazon Elastic Container Registry handelt) und Image-URL (wenn es sich bei der Registrierung um Andere Registry handelt).
Schritte
(action-name/Configuration/Steps)
(Erforderlich)
Geben Sie die Shell-Befehle an, die Sie während der Aktion zur Installation, Konfiguration und Ausführung Ihrer Build-Tools ausführen möchten.
Hier ist ein Beispiel für die Erstellung eines NPM-Projekts:
Steps:
- Run: npm install
- Run: npm run build
Hier ist ein Beispiel für die Angabe von Dateipfaden:
Steps:
- Run: cd $ACTION_BUILD_SOURCE_PATH_WorkflowSource/app && cat file2.txt
- Run: cd $ACTION_BUILD_SOURCE_PATH_MyBuildArtifact/build-output/ && cat file.txt
Weitere Hinweise zum Angeben von Dateipfaden finden Sie unter Quell-Repository-Dateien referenzieren undReferenzieren von Dateien in einem Artefakt.
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Shell-Befehle“
Pakete
(action-name/Configuration/Packages)
(Optional)
Ein Abschnitt, in dem Sie ein Paket-Repository angeben können, das die Aktion zum Auflösen von Abhängigkeiten verwendet. Mit Paketen können Sie Softwarepakete, die für die Anwendungsentwicklung verwendet werden, sicher speichern und gemeinsam nutzen.
Weitere Informationen zu Paketen finden Sie unterVeröffentlichen und teilen Sie Softwarepakete in CodeCatalyst.
Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Pakete“
NpmConfiguration
(action-name/Configuration/Packages/NpmConfiguration)
(Erforderlich, falls Pakete enthalten)
Ein Abschnitt, der die Konfiguration für das npm-Paketformat definiert. Diese Konfiguration wird von einer Aktion während einer Workflow-Ausführung verwendet.
Weitere Informationen zur npm-Paketkonfiguration finden Sie unterVerwenden von npm.
Entsprechende Benutzeroberfläche: Konfiguration tab/Packages /Konfiguration hinzufügen/npm
PackageRegistries
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries)
(Erforderlich, falls enthalten) Pakete
Ein Abschnitt, in dem Sie die Konfigurationseigenschaften einer Reihe von Paket-Repositorys definieren können.
Entsprechende Benutzeroberfläche: Konfiguration tab/Packages /Hinzufügen configuration/npm/Paket-Repository hinzufügen
PackagesRepository
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries/PackagesRepository)
(Erforderlich, falls Pakete enthalten)
Geben Sie den Namen Ihres CodeCatalyst Paket-Repositorys an, das die Aktion verwenden soll.
Wenn Sie mehrere Standard-Repositorys angeben, hat das letzte Repository Vorrang.
Weitere Hinweise zu Paket-Repositorys finden Sie unter. Paket-Repositorys
Entsprechende Benutzeroberfläche: Konfiguration tab/Packages /Hinzufügen /Paket-Repository configuration/npm hinzufügen/ Paket-Repository
Bereiche
(action-name/Configuration/Packages/NpmConfiguration/PackageRegistries/Scopes)
(Optional)
Geben Sie eine Abfolge von Bereichen an, die Sie in Ihrer Paketregistrierung definieren möchten. Bei der Definition von Bereichen wird das angegebene Paket-Repository als Registrierung für alle aufgelisteten Bereiche konfiguriert. Wenn ein Paket mit dem Gültigkeitsbereich über den npm-Client angefordert wird, verwendet es dieses Repository anstelle des Standard-Repositorys. Jedem Bereichsnamen muss ein „@“ vorangestellt werden.
Wenn Sie übergeordnete Bereiche einbeziehen, hat das letzte Repository Vorrang.
Wenn Scopes es weggelassen wird, wird das angegebene Paket-Repository als Standardregistrierung für alle von der Aktion verwendeten Pakete konfiguriert.
Weitere Hinweise zu Gültigkeitsbereichen finden Sie unter Paket-Namespaces und Pakete mit Gültigkeitsbereich.
Entsprechende Benutzeroberfläche: Konfiguration tab/Packages /Add /Add Package configuration/npm Repository/ Scopes — optional
ExportAuthorizationToken
(action-name/Configuration/Packages/ExportAuthorizationToken)
(Optional)
Aktivieren oder deaktivieren Sie die Funktion für Exportautorisierungstoken. Wenn diese Option aktiviert ist, können exportierte Autorisierungstoken verwendet werden, um einen Paketmanager für die Authentifizierung bei CodeCatalyst Paket-Repositorys manuell zu konfigurieren. Sie können das Token als Umgebungsvariable verwenden, auf die in Ihren Aktionen verwiesen werden kann.
Gültige Werte sind true oder false.
Wenn ExportAuthorizationToken es weggelassen wird, ist die Standardeinstellungfalse.
Weitere Hinweise zum Exportautorisierungstoken finden Sie unterVerwenden von Autorisierungstoken in Workflow-Aktionen.
Entsprechende Benutzeroberfläche: Konfiguration tab/Packages/Autorisierungstoken exportieren