Estilo del código
  • Los ejemplos y módulos de Terraform deberían integrar documentación que describa sus funcionalidades y el cómo utilizarlas.
  • Enlaces en el sitio web del Terraform Registry son relevantes y no funcionarán, así que hacer uso de rutas absolutas en el README.md.
  • La documentación puede incluir diagramas creados con mermaid **** y planos creados con cloudfcraft.co.
  • Hacer uso de los **** hooks de pre-commit de Terraform **** para asegurarse de que el código es válido, de que está en el formato adecuado y está documentado adecuadamente antes de que sea pusheado a git y revisado por una persona.\

Documentación

Documentación generada automáticamente

pre-commit **** es un marco de trabajo -framework- para administrar y mantener hooks de precommit multi lenguaje. Está escrito en Python y es una herramienta potente para hacer algo de manera automática en la máquina del desarrollador antes de que el código sea commiteado al repositorio de git. Normalmente, es utilizado para ejecutar linters y formatear código (ver hooks soportados).
Con las configuraciones de Terraform, el pre-commit puede ser utilizado para formatear y validar código, así como actualizar documentación.
Se recomienda revisar el repositorio de pre-commit-terraform para la familiarización con el mismo, y con otros repositorios existentes (por ejemplo, terraform-aws-vpc) en donde está siendo utilizado.
@porhacer: Documentar versiones de módulos, liberaciones, GH Actions.

Recursos

Last modified 1mo ago
Export as PDF
Copy link
Edit on GitHub