arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

Estilo del código

circle-info
  • 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 **** y planos creados con .

  • Hacer uso de los **** **** 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.\

hashtag
Documentación

hashtag
Documentación generada automáticamente

**** 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 ).

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 para la familiarización con el mismo, y con otros repositorios existentes (por ejemplo, ) en donde está siendo utilizado.

@porhacer: Documentar versiones de módulos, liberaciones, GH Actions.

hashtag
Recursos

1. .

2. .

3. Publicación de blog por .

mermaidarrow-up-right
cloudfcraft.coarrow-up-right
hooks de pre-commit de Terraformarrow-up-right
pre-commitarrow-up-right
hooks soportadosarrow-up-right
repositorio de pre-commit-terraformarrow-up-right
terraform-aws-vpcarrow-up-right
Página principal de pre-commitarrow-up-right
Colección de git hooks para Terraform a ser usados con el framework pre-commitarrow-up-right
Dean Wilson: hooks de pre-commit y terraform – una red segura para tus repositoriosarrow-up-right