Exécuter le linting et les tests unitaires

• 6 minutes

GitHub Actions peut être utilisé pour automatiser les tâches déclenchées par des événements. Pour déclencher des vérifications de qualité du code lors de la création d’une demande de tirage, vous devez :

• Vérifiez votre code avec des linters et des tests unitaires.
• Intégrer des vérifications de code aux demandes de tirage.

Vérifier votre code

Il existe deux types courants de vérifications que vous devrez effectuer sur votre code : les linters et les tests unitaires.

Vous pouvez utiliser des linters pour vérifier si votre code respecte les directives de qualité définies par votre organisation. Par exemple, pour linter votre code avec Flake8, vous créerez un fichier de configuration .flake8 qui contient les règles auxquelles votre code doit adhérer.

Pour vérifier si le code fonctionne comme prévu, vous pouvez créer des tests unitaires. Pour tester facilement des parties spécifiques de votre code, vos scripts doivent contenir des fonctions. Vous pouvez tester des fonctions dans vos scripts en créant des fichiers de test. Pytest est un outil populaire pour tester le code Python.

Pour vérifier votre code à l’aide de GitHub Actions, vous devez :

• Installer l’outil (Flake8 ou Pytest).
• Exécuter les tests en spécifiant les dossiers de votre dépôt qui doivent être vérifiés.

Intégrer des vérifications de code aux demandes de tirage.

Pour déclencher un workflow GitHub Actions lors de la création d’une demande de tirage, vous pouvez utiliser on: pull_request.

Vous devez veiller à ce qu’une demande de tirage puisse être fusionnée uniquement lorsque toutes les vérifications de qualité ont réussi.

Pour intégrer les vérifications de code à toutes les demandes de tirage qui ciblent la branche principale, vous devez effectuer les étapes suivantes :

1. Accédez à l’onglet Paramètres dans votre dépôt.
2. Sélectionner des branches
3. Activez Exiger la réussite des vérifications d’état avant de fusionner dans la règle de protection de branche pour la branche principale.

Ici, vous pouvez rechercher et sélectionner vos linters et tests unitaires afin de les définir selon les besoins. Chaque fois que vous créerez par la suite une demande de tirage, vous remarquerez qu’elle déclenche votre workflow GitHub Actions, et vous pourrez fusionner la demande de tirage uniquement lorsque les workflows réussiront.