Formatarea codului
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 mermaid și schițe create cu cloudcraft.co.
Folosiți Terraform pre-commit hooks 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
pre-commit 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 supported hooks).
Cu configurații Terraform pre-commit poate fi folosit pentru a formata și valida codul, precum și pentru a actualiza documentația.
Verificați pre-commit-terraform repository pentru a vă familiariza cu acesta și cu repositories existente (ex.: terraform-aws-vpc) unde acesta este deja folosit.
terraform-docs
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 pre-commit-terraform hooks pentru a actualiza automat documentația.
@todo: Versiuni ale modulelor de documente, release, acțiuni GH
Resurse
Last updated