Création de modèles de workflow pour votre organisation

Vue d’ensemble

Les modèles de workflow permettent à tous les membres de votre organisation disposant de l’autorisation de créer des workflows de le faire plus rapidement et plus facilement. Quand vous créez un workflow, vous pouvez choisir un modèle de workflow et une partie ou la totalité du travail d’écriture du workflow est effectuée à votre place. Vous pouvez utiliser les modèles de workflow comme point de départ pour créer votre workflow personnalisé ou l’utiliser tel quel. Cela permet non seulement de gagner du temps, mais également de promouvoir la cohérence et les bonnes pratiques dans l’ensemble de votre organisation.

GitHub fournit des modèles de workflows prêts à l’emploi pour les catégories de haut niveau suivantes :

• Déploiement (CD) . Pour plus d’informations, consultez « À propos du déploiement continu avec GitHub Actions ».

• Intégration continue (CI) . Pour plus d’informations, consultez « À propos de l’intégration continue avec GitHub Actions ».

• Automatisation. Les modèles de workflows d’automatisation offrent des solutions pour automatiser les workflows, comme le triage des demandes de tirage (pull requests) et l’application d’une étiquette en fonction des chemins d’accès qui sont modifiés dans la demande de tirage ou l’accueil des utilisateurs qui sont contributeurs au référentiel pour la première fois.

Création d’un modèle de workflow

Les modèles de workflow peuvent être créés par les utilisateurs disposant d’un accès en écriture au dépôt .github public de l’organisation. Ils peuvent ensuite être utilisés par les membres de l’organisation qui disposent de l’autorisation de créer des workflows.

Cette procédure montre comment créer un modèle de workflow et un fichier de métadonnées. Le fichier de métadonnées décrit la façon dont les modèles de workflow sont présentés aux utilisateurs lors de la création d’un workflow.

1. S’il n’existe pas encore, créez un nouveau dépôt public nommé .github dans votre organisation.

2. Créez un répertoire nommé workflow-templates.

3. Créez votre nouveau fichier de workflow dans le répertoire workflow-templates.

   Si vous devez faire référence à la branche par défaut d’un dépôt, vous pouvez utiliser l’espace réservé $default-branch. Lorsqu’un workflow est créé, l’espace réservé est automatiquement remplacé par le nom de la branche par défaut du dépôt.

   Note

   Les valeurs suivantes dans la clé runs-on sont également traitées comme des espaces réservés :

   • « ubuntu-latest » est remplacé par « [ auto-hébergé ] »
   • « windows-latest » est remplacé par « [ auto-hébergé, windows ] »
   • « ubuntu-latest » est remplacé par « [ auto-hébergé, macOS ] »

   Par exemple, ce fichier nommé octo-organization-ci.yml illustre un workflow de base.

   YAML

   name: Octo Organization CI
   
   on:
     push:
       branches: [ $default-branch ]
     pull_request:
       branches: [ $default-branch ]
   
   jobs:
     build:
       runs-on: ubuntu-latest
   
       steps:
         - uses: actions/checkout@v4
   
         - name: Run a one-line script
           run: echo Hello from Octo Organization
   

4. Créez un fichier de métadonnées dans le répertoire workflow-templates. Le fichier de métadonnées doit porter le même nom que le fichier de workflow, mais au lieu de l’extension .yml, l’extension .properties.json doit lui être ajoutée. Par exemple, ce fichier nommé octo-organization-ci.properties.json contient les métadonnées d’un fichier de workflow nommé octo-organization-ci.yml :

   JSON

   {
       "name": "Octo Organization Workflow",
       "description": "Octo Organization CI workflow template.",
       "iconName": "example-icon",
       "categories": [
           "Go"
       ],
       "filePatterns": [
           "package.json$",
           "^Dockerfile",
           ".*\\.md$"
       ]
   }
   

   • name - Obligatoire. Nom du workflow. Celui-ci s’affiche dans la liste des workflows disponibles.

   • description - Obligatoire. Description du workflow. Celui-ci s’affiche dans la liste des workflows disponibles.

   • iconName - Facultatif. Spécifie une icône pour le workflow affiché dans la liste des workflows. Les types iconName possibles sont les suivants :

     • Fichier SVG stocké dans le répertoire workflow-templates. Pour référencer un fichier, la valeur doit être le nom du fichier sans son extension. Par exemple, un fichier SVG nommé example-icon.svg est référencé comme example-icon .
     • Icône de l’ensemble d’octicons de GitHub. Pour référencer un octicon, la valeur doit être octicon <icon name>. Par exemple : octicon smiley.

   • categories - Facultatif. Définit les catégories sous lesquelles le workflow est affiché. Vous pouvez utiliser des noms de catégorie à partir des listes suivantes :

     • Noms de catégorie généraux du dépôt starter-workflows.
     • Langages Linguist figurant dans la liste du dépôt linguist.
     • Piles techniques prises en charge figurant dans la liste du dépôt starter-workflows.

   • filePatterns - Facultatif. Permet d’utiliser le workflow si le dépôt de l’utilisateur a dans son répertoire racine un fichier qui correspond à une expression régulière définie.

Pour ajouter un autre modèle de workflow, ajoutez vos fichiers dans le même répertoire workflow-templates.

Étapes suivantes

Pour continuer à découvrir GitHub Actions, consultez « Utilisation de modèles de workflow ».