Ajouter une action organisée GitHub - Amazon CodeCatalyst

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Ajouter une action organisée GitHub

Une GitHub action organisée est une GitHub action mise à disposition dans la CodeCatalyst console et sert d'exemple d'utilisation d'une GitHub action dans un CodeCatalyst flux de travail.

Les GitHub actions sélectionnées sont regroupées dans l'action GitHub Actions créée par CodeCatalyst l'auteur, identifiée par l'identifiant. aws/github-actions-runner@v1 Par exemple, voici à quoi ressemble GitHub l'TruffleHog OSSaction organisée : 

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.

Dans le code précédent, l'action CodeCatalyst GitHub Actions (identifiée paraws/github-actions-runner@v1) enveloppe l' TruffleHog OSSaction (identifiée partrufflesecurity/trufflehog@v3.16.0), la faisant fonctionner dans un CodeCatalyst flux de travail.

Pour configurer cette action, vous devez remplacer les chaînes vides ci-dessous with: par vos propres valeurs. Par exemple :

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.

Pour ajouter une GitHub action sélectionnée à un flux de travail, procédez comme suit. Pour des informations générales sur l'utilisation GitHub des actions dans un CodeCatalyst flux de travail, consultezIntégration aux GitHub actions.

Note

Si votre GitHub action ne figure pas dans la liste des actions sélectionnées, vous pouvez toujours l'ajouter à votre flux de travail à l'aide de l'action GitHub Actions. Pour plus d’informations, consultez Ajouter l'GitHub action « Actions ».

Visual
Pour ajouter une GitHub action organisée à l'aide de l'éditeur visuel

  1. Ouvrez la CodeCatalyst console à l'adresse https://codecatalyst.aws/.

  2. Choisissez votre projet.

  3. Dans le volet de navigation, choisissez CI/CD, puis Workflows.

  4. Choisissez le nom de votre flux de travail. Vous pouvez filtrer par le nom du référentiel source ou de la branche où le flux de travail est défini, ou filtrer par nom ou statut du flux de travail.

  5. Choisissez Modifier.

  6. Choisissez Visual.

  7. En haut à gauche, choisissez + Actions pour ouvrir le catalogue d'actions.

  8. Dans la liste déroulante, sélectionnez GitHub.

  9. Parcourez ou recherchez une GitHub action, puis effectuez l'une des opérations suivantes :

    • Choisissez le signe plus (+) pour ajouter l'action au diagramme de flux de travail et ouvrir son volet de configuration.

      Ou

    • Choisissez le nom de l' GitHub action. La boîte de dialogue des détails de l'action apparaît. Dans cette boîte de dialogue :

      • (Facultatif) Choisissez Afficher la source pour afficher le code source de l'action.

      • Choisissez Ajouter au flux de travail pour ajouter l'action au diagramme du flux de travail et ouvrir son volet de configuration.

  10. Dans les onglets Entrées, Configuration et Sorties, complétez les champs en fonction de vos besoins. Pour une description de chaque champ, consultez le« GitHub  Actions » action YAML. Cette référence fournit des informations détaillées sur chaque champ (et la valeur de YAML propriété correspondante) disponible pour l'action GitHubActions, telle qu'elle apparaît à la fois dans l'éditeur visuel YAML et dans l'éditeur visuel.

    Pour plus d'informations sur les options de configuration disponibles pour l' GitHubaction sélectionnée, consultez sa documentation.

  11. (Facultatif) Choisissez Valider pour valider le YAML code du flux de travail avant de le valider.

  12. Choisissez Valider, entrez un message de validation, puis choisissez à nouveau Valider.

YAML
Pour ajouter une GitHub action organisée à l'aide de l'éditeur YAML

  1. Ouvrez la CodeCatalyst console à l'adresse https://codecatalyst.aws/.

  2. Choisissez votre projet.

  3. Dans le volet de navigation, choisissez CI/CD, puis Workflows.

  4. Choisissez le nom de votre flux de travail. Vous pouvez filtrer par le nom du référentiel source ou de la branche où le flux de travail est défini, ou filtrer par nom ou statut du flux de travail.

  5. Choisissez Modifier.

  6. Choisissez YAML.

  7. En haut à gauche, choisissez + Actions pour ouvrir le catalogue d'actions.

  8. Dans la liste déroulante, sélectionnez GitHub.

  9. Parcourez ou recherchez une GitHub action, puis effectuez l'une des opérations suivantes :

    • Choisissez le signe plus (+) pour ajouter l'action au diagramme de flux de travail et ouvrir son volet de configuration.

      Ou

    • Choisissez le nom de l' GitHub action. La boîte de dialogue des détails de l'action apparaît. Dans cette boîte de dialogue :

      • (Facultatif) Choisissez Afficher la source pour afficher le code source de l'action.

      • Choisissez Ajouter au flux de travail pour ajouter l'action au diagramme du flux de travail et ouvrir son volet de configuration.

  10. Modifiez les propriétés du YAML code en fonction de vos besoins. Une explication de chaque propriété disponible pour l'action GitHub Actions est fournie dans le« GitHub  Actions » action YAML.

    Pour plus d'informations sur les options de configuration disponibles pour l' GitHubaction sélectionnée, consultez sa documentation.

  11. (Facultatif) Choisissez Valider pour valider le YAML code du flux de travail avant de le valider.

  12. Choisissez Valider, entrez un message de validation, puis choisissez à nouveau Valider.