Beaucoup de solutions existent aujourd'hui pour brancher des hooks sur son workflow git local afin d'exécuter du code à chaque commit pour vérifier la qualité du code produit.

Certains sont très liés à un langage comme husky pour NodeJS ou Overcommit pour Ruby. La solution qui nous intéresse dans cet article est simplement nommée pre-commit et développée en Python.

Elle est très intéressante dans le domaine du CloudOps car les nombreux commits développés par la communauté permettent une couverture importante des technologies utilisées, notamment celles liées à l'IaC comme Terraform ou Helm.

L'implémentation la plus basique consiste en un simple fichier de configuration .pre-commit-config.yaml comme celui-ci :

Deux difficultés sont soulevées assez rapidement par l'utilisation massive de pre-commit :

Une des solutions pour contourner ce problème est de prendre exemple sur ce que l'on fait dans une autre technologie, la CICD. Dans Github Actions, il est possible de créer un dépôt de workflow réutilisable. Pour simuler ce comportement avec pre-commit, on peut créer un dépôt avec un ensemble de fichiers de pre-commit correspondants aux différents types de dépôt que l'on a :

Ensuite, on instancie ce dépôt en tant que submodule du dépôt principal et on créé un lien vers la config voulue :

Ainsi si on a une modification à faire sur la configuration des pre-commit, il suffit de faire la modification dans un seul dépôt central et de mettre à jour le submodule dans les dépôts où celui-ci est utilisé.

Actuellement il n'est pas possible de forcer l'installation des pre-commit lors du clonage du dépôt. Une solution bien que contraignante est de répliquer les différents workflows de pre-commit dans la CI en créant un workflow de CI par workflow de pre-commit. Il est également possible de réutiliser les pre-commit dans la CI et de lancer les pre-commit via la commande pre-commit run --all-files.

Config de pre-commits utilisés à Skale 5