Stili di codice
  • Esempi di moduli Terraform dovrebbero contenere la documentazione che spiega le features e come usarle.
  • Tutti i links nel README.md dovrebbero essere con path assoluti per fare in modo che il sito web Terraform Registry li mostri correttamente.
  • La documentation può includere diagrammi creati con mermaid e blueprints creati con cloudcraft.co.
  • Usa i Terraform pre-commit hooks per essere sicuri che il codice è valido, correttamente formattato e automaticamente documentation prima che venga pushato in git e controllato da altri sviluppatori.

Documentazione

Generare automaticamente la documentazione

pre-commit è un framework per amministrare e mantenere hooks per linguaggi multipli. È scritto in Python ed è un tool potente per fare qualcosa automaticamente sulla macchina dello sviluppatore prima che il codice venga committato sul repository git. Normalmente, è usato per far girare linters e formattare il codice (vedi supported hooks).
Con le configurazioni Terraform pre-commit può essere usato per formattare e validare il codice, come per aggiornare la documentatione.
Dai un'occhiato al repository pre-commit-terraform per prendere confidenza e anche ai repositories (eg, terraform-aws-vpc) dov'è già usato.

terraform-docs

terraform-docs è un tool che genera la documentaione dei moduli Terraform in vari formati di output. Puoi farlo girare manualmente (senza pre-commit hooks), oppure usare pre-commit-terraform hooks per fare in modo che la documentazione si aggiorni automaticamente.
@todo: Document module versions, release, GH actions

Risorse

Export as PDF
Copy link
Edit on GitHub
On this page
Documentazione
Generare automaticamente la documentazione
terraform-docs
Risorse