Style de code
  • Les exemples et les modules Terraform doivent contenir une documentation expliquant les fonctionnalités et comment les utiliser.
  • Tous les liens dans les fichiers README.md doivent être absolus pour que le site Web Terraform Registry les affiche correctement.
  • La documentation peut inclure des diagrammes créés avec mermaid et des plans créés avec cloudcraft.co.
  • Utilisez Terraform pre-commit hooks pour vous assurer que le code est valide, correctement formaté et automatiquement documenté avant qu'il ne soit transmis à git et examiné par des humains

Documentation

Documentation génèrée automatiquement

pre-commit est un cadre de gestion et de maintenance des hooks de pré-commit multilingues. Écrit en Python, il est un outil puissant pour faire quelque chose automatiquement sur la machine d'un développeur avant que le code ne soit validé dans un référentiel git. Normalement, il est utilisé pour exécuter des linters et formater du code (voir supported hooks).
Avec les configurations Terraform pre-commit peut être utilisé pour formater et valider le code, ainsi que pour mettre à jour la documentation.
Vérifiez le pre-commit-terraform repository pour vous familiariser avec lui, et les référentiels existants (par exemple, terraform-aws-vpc) où cela est déjà utilisé.

terraform-docs

terraform-docs est un outil qui génère la documentation des modules Terraform dans différents formats de sortie. Vous pouvez l'exécuter manuellement (sans crochets de pré-commit), ou utiliser pre-commit-terraform hooks pour obtenir la documentation mise à jour automatiquement.
@ToDo: Document module versions, release, GH actions

Resources

Export as PDF
Copy link
Edit on GitHub
On this page
Documentation
Documentation génèrée automatiquement
terraform-docs
Resources