Qu'est-ce que act

act permet aux développeurs d'exécuter leurs workflows GitHub Actions localement, offrant un retour d'information rapide et rationalisant le processus de développement. Cet outil émule l'environnement GitHub Actions, permettant aux utilisateurs de tester et de déboguer les workflows sans commettre et pousser les modifications vers un dépôt distant. Contrairement aux tests directs sur GitHub, act offre des cycles d'itération plus rapides et réduit le temps passé à attendre les pipelines CI/CD. Il utilise Docker pour exécuter les actions, assurant la cohérence avec l'environnement GitHub. Les développeurs bénéficient de boucles de rétroaction plus rapides, d'un débogage plus facile et de la possibilité de gérer et d'exécuter les actions directement depuis leur IDE préféré, tel que VS Code, grâce à des extensions.

Fonctionnalités principales de act

Exécution locale du workflow

Permet aux développeurs d'exécuter les workflows GitHub Actions localement, éliminant ainsi le besoin de pousser les modifications vers un dépôt distant pour les tests. Cela réduit considérablement les boucles de rétroaction, permettant une itération et un débogage plus rapides. Il émule l'environnement GitHub Actions, garantissant que les workflows se comportent de manière cohérente localement comme ils le feraient sur les serveurs de GitHub.

Exécution basée sur Docker

Utilise Docker pour exécuter les actions, garantissant un environnement cohérent et isolé qui reflète le runtime GitHub Actions. Cette approche garantit que les dépendances et les configurations sont gérées correctement, évitant les divergences entre l'exécution locale et distante. Il extrait ou construit des images Docker définies dans vos fichiers de workflow.

Simulation des variables d'environnement

Fournit un environnement simulé qui reflète les variables d'environnement de GitHub, y compris celles liées au dépôt, au commit et au runner. Cela garantit que les workflows peuvent accéder aux mêmes informations localement que sur GitHub, facilitant ainsi les tests et le débogage précis de la logique conditionnelle et des intégrations.

Intégration VS Code

Offre une intégration avec Visual Studio Code via une extension dédiée. Cette intégration permet aux développeurs d'exécuter et de tester les workflows directement depuis leur éditeur, offrant une expérience de développement transparente. Elle simplifie le processus d'itération sur les workflows et réduit le changement de contexte.

Prise en charge du moteur de conteneur personnalisé

Permet aux utilisateurs de spécifier un moteur de conteneur personnalisé, offrant une flexibilité dans la gestion de l'environnement d'exécution. Ceci est particulièrement utile pour les utilisateurs qui ont des exigences spécifiques ou qui préfèrent utiliser un moteur de conteneur différent de Docker par défaut. Il prend en charge divers moteurs de conteneurs via la configuration.

Prise en charge de GitHub Enterprise

Prend en charge GitHub Enterprise, permettant aux utilisateurs d'exécuter des workflows localement pour les dépôts hébergés sur leurs instances GitHub Enterprise privées. Ceci est crucial pour les organisations qui utilisent GitHub Enterprise pour leurs pipelines de développement et CI/CD, leur permettant de tester et de déboguer les workflows dans un environnement sécurisé et contrôlé.

Comment utiliser act

Installation : Installez act en utilisant votre gestionnaire de paquets préféré (par exemple, brew install act pour Homebrew sur macOS, ou suivez les instructions sur le site Web pour d'autres plateformes).,2. Naviguez vers votre dépôt : Changez votre répertoire vers la racine de votre dépôt Git contenant le répertoire .github/workflows.,3. Exécutez un workflow : Exécutez un workflow spécifique en utilisant la commande act -W .github/workflows/<your_workflow_file.yml>. Remplacez <your_workflow_file.yml> par le nom de fichier réel de votre workflow.,4. Spécifiez un job : Ciblez un job spécifique dans un workflow en ajoutant le nom du job à la commande : act -W .github/workflows/<your_workflow_file.yml> -j <job_name>.,5. Afficher la sortie : Observez la sortie dans votre terminal, qui simule le runner GitHub Actions, y compris les journaux, les variables d'environnement et tous les artefacts générés.,6. Personnaliser l'environnement : Utilisez l'indicateur -e pour passer des variables d'environnement aux actions, ou utilisez l'indicateur -s pour fournir des secrets.

Cas d’utilisation de act

Débogage du workflow

Les ingénieurs logiciels peuvent utiliser act pour déboguer localement des workflows complexes. Ils peuvent parcourir chaque action, inspecter les journaux et modifier les configurations sans commettre de modifications. Cela accélère le processus de débogage, réduisant le temps passé à résoudre les problèmes dans les pipelines CI/CD distants.

Développement CI/CD

Les développeurs peuvent utiliser act pour développer et tester de nouveaux workflows CI/CD avant de les déployer en production. Ils peuvent expérimenter différentes configurations, tester les intégrations et valider le comportement de leurs workflows localement, en s'assurant qu'ils fonctionnent correctement avant le déploiement.

Tests locaux des actions

Les responsables des GitHub Actions personnalisées peuvent utiliser act pour tester leurs actions localement. Ils peuvent simuler différentes entrées, tester divers scénarios et s'assurer que leurs actions se comportent comme prévu. Cela améliore la qualité et la fiabilité des actions personnalisées avant leur publication.

Itération plus rapide sur les modifications du workflow

Les développeurs peuvent utiliser act pour itérer rapidement sur les modifications apportées à leurs fichiers de workflow. Au lieu d'attendre une exécution complète du CI/CD, ils peuvent tester leurs modifications localement et recevoir un retour d'information immédiat. Cela accélère considérablement le processus de développement et augmente la productivité.

Qui bénéficie de act

Ingénieurs logiciels

Les ingénieurs logiciels bénéficient d'act en étant capables de tester et de déboguer rapidement leurs workflows GitHub Actions localement, réduisant ainsi le temps passé à attendre les pipelines CI/CD et améliorant l'efficacité globale du développement.

Ingénieurs DevOps

Les ingénieurs DevOps peuvent utiliser act pour développer et valider les pipelines CI/CD localement, en s'assurant que les workflows sont correctement configurés et fonctionnent comme prévu avant de les déployer dans les environnements de production.

Spécialistes CI/CD

Les spécialistes CI/CD peuvent tirer parti d'act pour tester et dépanner des workflows complexes, en s'assurant que tous les aspects du processus CI/CD fonctionnent correctement et efficacement.

Contributeurs Open Source

Les contributeurs open source peuvent utiliser act pour tester et contribuer à des projets qui utilisent GitHub Actions. Cela leur permet de valider rapidement leurs modifications et d'assurer la compatibilité avec la configuration CI/CD du projet.

Autres outils similaires à act

Fly.io

Fly.io est une plateforme cloud qui permet aux développeurs de déployer des applications à l'échelle mondiale avec une faible latence et des performances élevées.