Terraform-docsの導入方法と利用例についてお伺いしたいです。
AWSエンジニアをしています。
チームでterraformによる開発の際、ドキュメントが生成できるツール「Terraform-docs」があると知りました。
私の在籍していたプロジェクトではチームの人数も少なく、ドキュメントはほぼ無かったのですが、あると便利だなと調べていて感じました。
そこでTerraform-docsの導入方法や利用例について知りたいです。
Windows環境やLinux環境、GitHub、AWSでの導入方法について教えてください。
また、これはソースコードの修正があった場合は毎回実施するものなのでしょうか?
企業での利用例についても教えていただけたら幸いです。
チームでterraformによる開発の際、ドキュメントが生成できるツール「Terraform-docs」があると知りました。
私の在籍していたプロジェクトではチームの人数も少なく、ドキュメントはほぼ無かったのですが、あると便利だなと調べていて感じました。
そこでTerraform-docsの導入方法や利用例について知りたいです。
Windows環境やLinux環境、GitHub、AWSでの導入方法について教えてください。
また、これはソースコードの修正があった場合は毎回実施するものなのでしょうか?
企業での利用例についても教えていただけたら幸いです。
1年前
view数 517
回答を投稿して企業にアピールしましょう!
Q&Aで投稿された回答は、
企業側に表示されるプロフィールにも投稿履歴として表示されます。
Offersにログイン・新規登録して、気になるテーマやトピックを話してみよう!
\回答があります!/
Suzuki Yutaro
エンジニア
1年前
まず、terraform-docs自体について調べてみましょう。
https://terraform-docs.io/
https://github.com/terraform-docs/terraform-docs
ざっくり以下のようなことができます。
https://devops-blog.virtualtech.jp/entry/20230310/1678416395
GitHub Actionsで使用する例は例えばこんな感じです
https://dev.classmethod.jp/articles/terraform-docs-gh-pr-generate-doc/
ドキュメント生成に使用する情報を変更しなければ生成されるドキュメントにも変更は発生しませんが、変更が発生しようがしまいがソースの変更をトリガーに毎回生成すれば、結果的に変更があったときのものが都度反映されるでしょう。
あれこれ見る前にまずはご自分で試してみたほうがわかりやすいでしょう。view数 278