代码风格

  • 示例和 Terraform 模块应包含说明功能及其使用方法的文档。

  • README.md 文件中的所有链接都应该是绝对链接,以使 Terraform Registry 网站正确显示它们。

  • 文档可能包括使用mermaid创建的图表和使用cloudcraft.co创建的蓝图。

  • 使用 Terraform pre-commit hooks 确保代码有效、格式正确并自动记录,然后再推送到 git 并由人工审查。

Documentation(文档)

自动生成的文档

pre-commit 是一个用于管理和维护多语言预提交挂钩的框架。它是用 Python 编写的,是一个强大的工具,可以在代码提交到 git 存储库之前在开发人员的机器上自动执行某些操作。通常,它用于运行 linters 和格式化代码(参见supported hooks)。

通过 Terraform 配置,pre-commit可用于格式化和验证代码,以及更新文档。

查看 pre-commit-terraform repository 以熟悉它,以及已经使用它的现有存储库(例如, terraform-aws-vpc)。

terraform-docs

terraform-docs 是一种工具,可以从 Terraform 模块以各种输出格式完成文档的生成。你可以手动运行它(没有预提交挂钩),或使用 pre-commit-terraform hooks 来自动更新文档。

@todo:记录模块版本、发布、GH actions

参考资源

  1. 预提交框架主页:pre-commit framework homepage

  2. 用于预提交框架的Terraform 的 git 钩子集合:Collection of git hooks for Terraform to be used with pre-commit framework

Last updated