Quickstart for 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. You can create workflows that run tests whenever you push a change to your repository, or that deploy merged pull requests to production.

This quickstart guide shows you how to use the user interface of GitHub to add a workflow that demonstrates some of the essential features of 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 « Using workflow templates ».

For an overview of GitHub Actions workflows, see À propos des workflows. If you want to learn about the various components that make up GitHub Actions, see Understanding GitHub Actions.

Using workflow templates

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.

Prerequisites

This guide assumes that:

• You have at least a basic knowledge of how to use GitHub. If you don't, you'll find it helpful to read some of the articles in the documentation for repositories and pull requests first. For example, see Guide de démarrage rapide pour les dépôts, À propos des branches, and À propos des demandes de tirage (pull requests).

• You have a repository on GitHub where you can add files.

• You have access to GitHub Actions.

  Remarque

  If the Actions tab is not displayed under the name of your repository on GitHub, it may be because Actions is disabled for the repository. For more information, see Gestion des paramètres de GitHub Actions pour un dépôt.

Creating your first workflow

1. In your repository on GitHub, create a workflow file called github-actions-demo.yml in the .github/workflows directory. To do this:

   • If the .github/workflows directory already exists, navigate to that directory on GitHub, click Add file, then click Create new file, and name the file github-actions-demo.yml.

   • If your repository doesn't have a .github/workflows directory, go to the main page of the repository on GitHub, click Add file, then click Create new file, and name the file .github/workflows/github-actions-demo.yml. This creates the .github and workflows directories and the github-actions-demo.yml file in a single step.

   Remarque

   For GitHub to discover any GitHub Actions workflows in your repository, you must save the workflow files in a directory called .github/workflows.

   You can give the workflow file any name you like, but you must use .yml or .yaml as the file name extension. YAML is a markup language that's commonly used for configuration files.

2. Copy the following YAML contents into the github-actions-demo.yml file:

   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@v4
         - 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 }}."
   

   At this stage you don't need to understand the details of this workflow. For now, you can just copy and paste the contents into the file. After completing this quickstart guide, you can learn about the syntax of workflow files in À propos des workflows, and for an explanation of GitHub Actions contexts, such as ${{ github.actor }} and ${{ github.event_name }}, see Accès à des informations contextuelles sur l’exécution d’un workflow.

3. Click Commit changes.

4. In the "Propose changes" dialog, select either the option to commit to the default branch or the option to create a new branch and start a pull request. Then click Commit changes or Propose changes.

   

Committing the workflow file to a branch in your repository triggers the push event and runs your workflow.

If you chose to start a pull request, you can continue and create the pull request, but this is not necessary for the purposes of this quickstart because the commit has still been made to a branch and will trigger the new workflow.

Viewing your workflow results

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

2. Sous le nom de votre dépôt, cliquez sur Actions.

   

3. In the left sidebar, click the workflow you want to display, in this example "GitHub Actions Demo."

   

4. From the list of workflow runs, click the name of the run you want to see, in this example "USERNAME is testing out GitHub Actions."

5. In the left sidebar of the workflow run page, under Jobs, click the Explore-GitHub-Actions job.

   

6. The log shows you how each of the steps was processed. Expand any of the steps to view its details.

   

   For example, you can see the list of files in your repository:

   

The example workflow you just added is triggered each time code is pushed to the branch, and shows you how GitHub Actions can work with the contents of your repository. For an in-depth tutorial, see Understanding GitHub Actions.

Next steps

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 Using workflow templates.
• Pour connaître les workflows d’intégration continue (CI), consultez Building and testing.
• Pour générer et publier des packages, consultez Publishing packages.
• Pour le déploiement de projets, consultez Use cases and examples.
• Pour automatiser les tâches et les processus sur GitHub, consultez Managing projects.
• Pour obtenir des exemples illustrant des fonctionnalités plus complexes de GitHub Actions, consultez Use cases and examples. 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.