Démarrage rapide pour GitHub Actions

Introduction

GitHub Actions est une plateforme d’intégration continue et livraison continue (CI/CD) qui vous permet d’automatiser votre pipeline de génération, de test et de déploiement. Vous pouvez créer des workflows qui exécutent des tests chaque fois que vous apportez une modification à votre référentiel, ou qui déploient en production des demandes de tirage fusionnées.

Ce guide de démarrage rapide vous montre comment utiliser l’interface utilisateur de GitHub pour ajouter un workflow qui illustre certaines des fonctionnalités essentielles de GitHub Actions.

Pour commencer à utiliser les flux de travail préconfigurés, parcourez la liste des modèles dans le référentiel actions/starter-workflows. Pour plus d’informations, consultez « Utilisation de modèles de workflow ».

Pour une vue d'ensemble des flux de travail GitHub Actions, consultez « Workflows ». Si vous souhaitez en savoir plus sur les différents composants qui composent GitHub Actions, consultez « Comprendre GitHub Actions ».

Utilisation de modèles de workflow

GitHub fournit des modèles de flux de travail préconfigurés que vous pouvez utiliser tels quels ou personnaliser pour créer votre propre flux de travail. GitHub analyse votre code et vous affiche des modèles de flux de travail qui pourraient être utiles pour votre référentiel. Par exemple, si votre référentiel contient du code Node.js, vous verrez des suggestions de projets Node.js.

Ces modèles de workflow sont conçus pour vous aider à être rapidement opérationnel, en offrant une gamme de configurations telles que :

• CI : workflows d’intégration continue
• Déploiements : workflows de déploiement
• Automatisation : automatisation des workflows
• Analyse du code : workflows d’analyse du code
• Pages : workflows de pages

Utilisez ces workflows comme point de départ pour générer votre propre workflow ou utilisez-les tels quels. Vous pouvez parcourir la liste complète des modèles de flux de travail dans le référentiel actions/starter-workflows.

Prérequis

Ce guide part du principe que :

• Vous avez au moins une connaissance de base de l’utilisation des données GitHub. Si ce n’est pas le cas, vous trouverez qu’il est utile de lire certains articles de la documentation pour les référentiels et les demandes de tirage en premier. Par exemple, consultez « Guide de démarrage rapide pour les dépôts », « À propos des branches » et « À propos des demandes de tirage (pull requests) ».

• Vous disposez d’un dépôt sur GitHub où vous pouvez ajouter des fichiers.

• Vous avez accès à GitHub Actions.

  Remarque

  Si l’onglet Actions n'est pas affiché sous le nom de votre référentiel sur la page GitHub, c'est peut-être parce que les actions sont désactivées pour le référentiel. Pour plus d’informations, consultez « Gestion des paramètres de GitHub Actions pour un dépôt ».

Création de votre premier workflow

1. Dans votre dépôt sur GitHub, créez un fichier de workflow appelé github-actions-demo.yml dans le répertoire .github/workflows. Pour ce faire :

   • Si le répertoire .github/workflows existe déjà, accédez à ce répertoire sur GitHub, cliquez sur Ajouter un fichier, puis cliquez sur Créer un fichier et nommez le fichier github-actions-demo.yml.

   • Si votre référentiel n’a pas de répertoire .github/workflows, accédez à la page principale du référentiel sur GitHub, cliquez sur Ajouter un fichier, puis cliquez sur Créer un fichier et nommez le fichier .github/workflows/github-actions-demo.yml. Cela crée les répertoires .github et workflows le fichier github-actions-demo.yml en une seule étape.

   Remarque

   Pour GitHub pour découvrir les workflows GitHub Actions dans votre référentiel, vous devez enregistrer les fichiers de workflow dans un répertoire appelé .github/workflows.

   Vous pouvez donner au fichier de workflow n’importe quel nom de votre choix, mais vous devez utiliser .yml ou .yaml comme extension de nom de fichier. YAML est un langage de balisage couramment utilisé pour les fichiers de configuration.

2. Copiez le contenu YAML suivant dans le fichier github-actions-demo.yml :

   YAML

   name: GitHub Actions Demo
   run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
   on: [push]
   jobs:
     Explore-GitHub-Actions:
       runs-on: ubuntu-latest
       steps:
         - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
         - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
         - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
         - name: Check out repository code
           uses: actions/checkout@v5
         - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
         - run: echo "🖥️ The workflow is now ready to test your code on the runner."
         - name: List files in the repository
           run: |
             ls ${{ github.workspace }}
         - run: echo "🍏 This job's status is ${{ job.status }}."
   

   À ce stade, vous n’avez pas besoin de comprendre les détails de ce workflow. Pour l’instant, vous pouvez simplement copier et coller le contenu dans le fichier. Une fois ce guide de démarrage rapide terminé, vous pouvez découvrir la syntaxe des fichiers de workflow dans « Workflows${{ github.event_name }} » et pour obtenir une explication des contextes GitHub Actions, tels que et ${{ github.actor }}, consultez « Référence des contextes ».

3. Cliquez sur Valider les changements.

4. Dans la boîte de dialogue « Proposer des modifications », sélectionnez l’option à valider dans le branche par défaut ou l’option permettant de créer une branche et de démarrer une demande de tirage. Cliquez sur Valider les modifications ou Proposer des modifications.

   

Le commit du fichier de workflow dans une branche de votre dépôt déclenche l’événement push et exécute votre workflow.

Si vous avez choisi de démarrer une demande de tirage, vous pouvez continuer et créer la demande de tirage, mais cela n’est pas nécessaire pour les besoins de ce guide de démarrage rapide, car le commit a toujours été effectué dans une branche et déclenchera le nouveau workflow.

Affichage des résultats de votre workflow

1. Sur GitHub, accédez à la page principale du référentiel.

2. Sous le nom de votre référentiel, cliquez sur Actions.

   

3. Dans la barre latérale gauche, cliquez sur le workflow que vous souhaitez afficher, dans cet exemple « GitHub Actions Demo ».

   

4. Dans la liste des exécutions de workflow, cliquez sur le nom de l’exécution que vous souhaitez voir, dans cet exemple « USERNAME is testing out GitHub Actions ».

5. Dans la barre latérale gauche de la page d’exécution du workflow, sous Travaux, cliquez sur le travail Explore-GitHub-Actions.

   

6. Le journal vous montre comment chacune des étapes a été traitée. Développez l’une des étapes pour afficher ses détails.

   

   Par exemple, vous pouvez voir la liste des fichiers dans votre référentiel :

   

L’exemple de workflow que vous venez d’ajouter est déclenché chaque fois que du code est poussé vers la branche, et montre comment GitHub Actions peut fonctionner avec le contenu de votre dépôt. Pour suivre un tutoriel détaillé, consultez « Comprendre GitHub Actions ».

Étapes suivantes

GitHub Actions peut vous aider à automatiser presque tous les aspects de vos processus de développement d’applications. Vous êtes prêt à commencer ? Voici quelques ressources utiles pour effectuer vos étapes suivantes avec GitHub Actions :

• Pour créer un workflow GitHub Actions, consultez Utilisation de modèles de workflow.
• Pour connaître les workflows d’intégration continue (CI), consultez Génération et test de votre code.
• Pour générer et publier des packages, consultez Publication de packages.
• Pour le déploiement de projets, consultez Déploiement sur des plateformes tierces.
• Pour automatiser les tâches et les processus sur GitHub, consultez Gestion de votre travail avec GitHub Actions.
• Pour obtenir des exemples illustrant des fonctionnalités plus complexes de GitHub Actions, consultez Gestion de votre travail avec GitHub Actions. Ces exemples détaillés expliquent comment tester votre code sur un exécuteur et accéder à la CLI GitHub. Ils montrent également comment utiliser des fonctions avancées telles que la concurrence et les matrices de test.