Terraform Best Practices
Terraform consultingTwitter @antonbabenkoTerraform Weekly
Română (Romanian)
Română (Romanian)
  • Bine ați venit
  • Concepte cheie
  • Structura codului
  • Exemple de structuri de cod
    • Terragrunt
    • Terraform
      • Infrastructură de dimensiune mică - Terraform
      • Infrastructură de dimensiune medie - Terraform
      • Infrastructură de dimensiune mare - Terraform
  • Convenții de numire
  • Formatarea codului
  • FAQ
  • Referințe
  • Scrierea configurațiilor Terraform
  • Workshop
Powered by GitBook
On this page
  • Documentație
  • Documentație generată automat
  • terraform-docs
  • Resurse
Export as PDF

Formatarea codului

PreviousConvenții de numireNextFAQ

Last updated 2 years ago

  • Exemplele și modulele Terraform ar trebui să conțină documentație care explică caracteristicile și modul de utilizare a acestora.

  • Toate linkurile din fișierele README.md ar trebui să fie absolute pentru ca site-ul Terraform Registry să le arate corect.

  • Documentația poate include diagrame create cu și schițe create cu .

  • Folosiți to asigurați-vă că codul este valid, formatat corespunzător și documentat automat înainte de a fi salvat în git și revizuit de oameni.

Documentație

Documentație generată automat

este un cadru (framework) pentru gestionarea și menținerea pre-commit hooks în mai multe limbi. Este scris în Python și este un instrument puternic pentru a face ceva automat pe mașina unui dezvoltator înainte ca acel cod să fie salvat într-un git repository. În mod normal, este folosit pentru a rula linters și pentru a formata cod (vezi ).

Cu configurații Terraform pre-commit poate fi folosit pentru a formata și valida codul, precum și pentru a actualiza documentația.

Verificați pentru a vă familiariza cu acesta și cu repositories existente (ex.: ) unde acesta este deja folosit.

terraform-docs

este un instrument care generează documentație din modulele Terraform în diverse formate de ieșire. Îl puteți rula manual (fără pre-commit hooks) sau puteți utiliza pentru a actualiza automat documentația.

@todo: Versiuni ale modulelor de documente, release, acțiuni GH

Resurse

  1. Blog post de :

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