Fiche de référence GitHub Actions – Structure standard et liste des actions les plus utiles

GitHub Actions est une plateforme d’automatisation et de CI/CD intégrée à GitHub, utilisée pour construire, tester et déployer votre code en fonction d’événements tels que des pushes, des pull requests, ou selon un calendrier.

En plus du GitHub standard, vous pouvez utiliser GitHub Actions sur un serveur Gitea auto-hébergé.

Les Actions englobent des outils officiels, communautaires et tiers, prenant en charge l’automatisation depuis les constructions et les tests jusqu’au déploiement, la gestion des versions, l’assurance qualité (QA) et les notifications.

Ce résumé couvre la structure des actions GitHub, une brève description et les actions les plus couramment utilisées dans les flux de travail open source et commerciaux. Il fait partie de Outils de développement : Le guide complet des flux de travail de développement moderne.

Structure de configuration de base

Les workflows GitHub Actions sont définis dans des fichiers YAML situés dans le répertoire .github/workflows du dépôt.

name: Workflow Name
on:
  push:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - name: Run tests
        run: npm test

• Le bloc on spécifie les événements déclencheurs.
• Chaque job s’exécute sur son propre runner.
• Les steps peuvent exécuter des commandes shell ou appeler des actions réutilisables.

Composants principaux du workflow

Événements déclencheurs

• push
• pull_request
• schedule (utilisant la syntaxe cron)
• workflow_dispatch (déclencheur manuel, permet des paramètres d’entrée)
• release, issue, etc.

Exemple :

on:
  push:
    branches: [ main ]
  workflow_dispatch:
    inputs:
      environment:
        description: 'Deployment Environment'
        required: true
        default: 'production'
        type: string

Actions intégrées utiles

Paramètres d’action

Paramètres généraux pour n’importe quel appel d’action :

- name: Some Action or Step
  uses: owner/repo@ref
  with:
    param1: value
    param2: value
  env:
    ENV_VAR: value
  if: ${{ condition }}
  run: command_to_run
  shell: bash|pwsh|python|sh
  continue-on-error: true|false

• with : arguments passés à l’action (voir la documentation de l’action pour toutes les options)
• env : variables d’environnement pour l’étape
• if : exécution conditionnelle
• run : commandes shell (si l’on n’utilise pas une action)
• shell : shell utilisé pour exécuter l’étape
• continue-on-error : continuer même si l’étape échoue

Définition des entrées d’action personnalisées

Dans votre métadonnées d’action (action.yml) :

inputs:
  example-input:
    description: 'An example input'
    required: false
    default: 'default-value'

Lorsqu’il est utilisé dans un workflow :

- uses: my/action@v1
  with:
    example-input: 'custom-value'

Accédé comme variable d’environnement INPUT_EXAMPLE_INPUT lorsque l’action s’exécute.

Exemple : Workflow avec paramètres manuels

name: Deploy
on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Deployment Environment'
        required: true
        default: 'production'
        type: string
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Deploy to environment
        run: echo "Deploying to ${{ github.event.inputs.environment }}"

Marketplace des Actions

• Des milliers d’actions réutilisables sont disponibles sur le GitHub Marketplace.
• Les catégories incluent : déploiements cloud, outils de notification, frameworks de test, analyse de code, et plus encore.
• Explorez : actions/checkout, actions/setup-node, docker/build-push-action, actions/cache, actions/upload-artifact, et bien d’autres.

Conseils rapides

• Placez les fichiers de workflow dans .github/workflows.
• Utilisez workflow_dispatch avec inputs pour les exécutions manuelles et paramétrées.
• Utilisez l’action cache pour accélérer l’installation des dépendances.
• Utilisez une matrix de job pour tester plusieurs versions OS/runtime.
• Utilisez des secrets pour les données sensibles, référencés comme ${{ secrets.SECRET_NAME }}.

Cette fiche pratique couvre l’essentiel de l’utilisation, de la configuration et de l’extension de GitHub Actions pour l’automatisation, la CI/CD et plus encore. Pour plus de détails et de mises à jour, consultez toujours la documentation officielle de GitHub et les dépôts d’actions.

Actions GitHub courantes

Voici une liste pratique d’actions GitHub fréquemment utilisées pour automatiser la CI/CD, les tests, la construction, le déploiement et les tâches de workflow :

Actions officielles principales

Actions populaires de la communauté et tierces

Actions de test, QA et reporting

Actions de déploiement et de notification

Utilitaires et gestion de workflow

Comment en trouver plus

Il existe de nombreuses actions GitHub qui permettent l’automatisation des workflows, telles que les tests automatisés, le déploiement en production, les notifications et les intégrations avec d’autres services. Le GitHub Marketplace liste des milliers d’actions dans des catégories telles que les tests, la sécurité, le déploiement, les notifications, la qualité du code et les intégrations. Les listes curatées telles que “Awesome Actions” sont également excellentes pour l’inspiration et la découverte.

Liens utiles

• https://docs.github.com/actions
• https://github.com/marketplace
• https://docs.github.com/en/actions/get-started/quickstart
• https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
• Fiche pratique Git
• Gitea - installation et test
• Sauvegarde et restauration du serveur Gitea
• Utiliser Gitea Actions pour déployer un site Hugo vers AWS S3
• Gitflow : Étapes, alternatives, avantages et inconvénients
• DevOps avec GitOps - Argo CD, Flux, Jenkins X, Weave GitOps et autres