Fiche de raccourcis GitHub Actions - Structure standard et liste des actions les plus utiles

GitHub Actions
est une plateforme d’automatisation et de CI/CD au sein de GitHub, utilisée pour construire, tester et déployer votre code en fonction d’événements tels que les pushes, les demandes de fusion ou un calendrier.

En plus de l’utilisation standard de GitHub, vous pouvez utiliser GitHub Actions sur un serveur Gitea auto-hébergé.

Ce résumé couvre la structure de GitHub Actions, une courte description et les actions les plus courantes utilisées dans les workflows open source et commerciaux. Les actions englobent des outils officiels, communautaires et tiers, soutenant l’automatisation des builds et des tests jusqu’au déploiement, la gestion des versions, le QA et les notifications.

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: Nom du workflow
on:
  push:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Configurer Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - name: Exécuter les 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 en shell ou appeler des actions réutilisables.

Composants principaux du workflow

Événements de déclenchement

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

Exemple :

on:
  push:
    branches: [ main ]
  workflow_dispatch:
    inputs:
      environment:
        description: 'Environnement de déploiement'
        required: true
        default: 'production'
        type: string

Actions utiles intégrées

Paramètres d’action

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

- name: Certaine action ou étape
  uses: owner/repo@ref
  with:
    param1: valeur
    param2: valeur
  env:
    ENV_VAR: valeur
  if: ${{ condition }}
  run: commande_à_exécuter
  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 en shell (si 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éfinir des entrées d’action personnalisées

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

inputs:
  example-input:
    description: 'Un exemple d'entrée'
    required: false
    default: 'valeur-par-défaut'

Lorsqu’elle est utilisée dans un workflow :

- uses: my/action@v1
  with:
    example-input: 'valeur-personnalisée'

Accédée comme variable d’environnement INPUT_EXAMPLE_INPUT lors de l’exécution de l’action.

Exemple : Workflow avec des paramètres manuels

name: Déployer
on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Environnement de déploiement'
        required: true
        default: 'production'
        type: string
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Vérifier le code
        uses: actions/checkout@v4
      - name: Déployer à l'environnement
        run: echo "Déploiement vers ${{ github.event.inputs.environment }}"

Marché des actions

• Des milliers d’actions réutilisables sont disponibles sur le GitHub Marketplace.
• Les catégories incluent : déploiements en nuage, outils de notification, cadres de test, analyse de code, etc.
• Explorer : 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 la matrice de jobs pour tester plusieurs versions d’OS/running.
• Utilisez les secrets pour les données sensibles, référencés comme ${{ secrets.SECRET_NAME }}.

Ce guide couvre les éléments essentiels pour utiliser, configurer et étendre GitHub Actions pour l’automatisation, le CI/CD et bien plus. 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 des actions GitHub fréquemment utilisées pour automatiser le CI/CD, les tests, les builds, le déploiement et les tâches de workflow :

Actions officielles principales

Actions populaires de la communauté et tiers

Actions de test, QA et rapports

Actions de déploiement et de notification

Actions d’utilité et de gestion de workflow

Comment en trouver davantage

Il existe de nombreuses actions GitHub qui permettent l’automatisation des workflows, tels 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 comme les tests, la sécurité, le déploiement, les notifications, la qualité du code et les intégrations. Des listes curatées comme “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
• GIT Cheatsheet
• Gitea - installation et tests
• 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