Стиль коду
Документація
Автоматично згенерована документація
pre-commit - це фреймворк для керування та підтримки багатомовних pre-commit хуків. Він написаний на Python і є потужним інструментом для автоматичного виконання завдань на машині розробника до того, як код буде передано в репозиторій git. Зазвичай він використовується для запуску лінтерів і форматування коду (дивіться підтримувані хуки).
З конфігураціями Terraform pre-commit
можна використовувати для форматування та перевірки коду, а також для оновлення документації.
Перегляньте pre-commit-terraform repository, щоб ознайомитися з ним та існуючими репозиторіями (наприклад, terraform-aws-vpc), де це вже використовується.
terraform-docs
terraform-docs - це інструмент, який створює документацію з модулів Terraform у різних вихідних форматах. Ви можете запускати його вручну (без pre-commit хуків, або ж використовувати pre-commit-terraform hooks, щоб документація оновлювалася автоматично).
@todo: Document module versions, release, GH actions
Ресурси
Last updated