All pages
Powered by GitBook
1 of 1

Loading...

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 et des plans créés avec .

  • Utilisez 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

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 ).

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 pour vous familiariser avec lui, et les référentiels existants (par exemple, ) où cela est déjà utilisé.

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 pour obtenir la documentation mise à jour automatiquement.

@ToDo: Document module versions, release, GH actions

Resources

  1. Blog posté par :

mermaid
cloudcraft.co
Terraform pre-commit hooks
pre-commit
supported hooks
pre-commit-terraform repository
terraform-aws-vpc
terraform-docs
pre-commit-terraform hooks
pre-commit framework homepage
Collection of git hooks for Terraform to be used with pre-commit framework
Dean Wilson
pre-commit hooks and terraform - a safety net for your repositories