Code-Styling
  • Beispiele und Terraform-Module sollten eine Dokumentation enthalten, in der die Funktionen und deren Verwendung erklärt werden.
  • Alle Links in README.md-Dateien sollten absolut sein, damit die Terraform Registry Website sie korrekt anzeigt.
  • Die Dokumentation kann mit mermaid erstellte Diagramme und mit cloudcraft.co erstellte Blueprints enthalten.
  • Verwenden Sie Terraform Pre-Commit Hooks, um sicherzustellen, dass der Code gültig, richtig formatiert und automatisch dokumentiert ist, bevor er nach Git gepusht und von Menschen überprüft wird.

Dokumentation

Automatisch erstellte Dokumentation

pre-commit ist ein Framework für die Verwaltung und Pflege von Pre-Commit-Hooks für mehrere Programmiersprachen. Es ist in Python geschrieben und ist ein leistungsfähiges Werkzeug, um auf dem Rechner eines Entwicklers automatisch etwas zu tun, bevor der Code in ein Git-Repository übertragen wird. Normalerweise wird es verwendet, um Linter auszuführen und Code zu formatieren (siehe unterstützte Hooks).
Mit Terraform-Konfigurationen kann pre-commit verwendet werden, um Code zu formatieren und zu validieren, sowie um die Dokumentation zu aktualisieren.
Schauen Sie sich das pre-commit-terraform Repository an, um sich damit vertraut zu machen, sowie bestehende Repositories (z.B. terraform-aws-vpc), in denen dies bereits verwendet wird.

terraform-docs

terraform-docs ist ein Werkzeug, das die Dokumentation von Terraform-Modulen in verschiedenen Ausgabeformaten erzeugt. Sie können es manuell ausführen (ohne pre-commit hooks), oder pre-commit-terraform hooks verwenden, um die Dokumentation automatisch zu aktualisieren.
@todo: Document module versions, release, GH actions

Ressourcen