From 69ae923d1b6093db509bacafa45ca5a8e9d4a97a Mon Sep 17 00:00:00 2001
From: kirby <kirby@hyrule.ovh>
Date: Thu, 22 May 2025 15:32:40 +0200
Subject: [PATCH] add terraform

---
 terraform/terraform-docs.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 terraform/terraform-docs.md

diff --git a/terraform/terraform-docs.md b/terraform/terraform-docs.md
new file mode 100644
index 0000000..b9e24e8
--- /dev/null
+++ b/terraform/terraform-docs.md
@@ -0,0 +1,25 @@
+## Auto-generated documentation for Terraform module
+
+### Installation de terraform-docs
+
+```bash
+cd /tmp/
+wget https://github.com/terraform-docs/terraform-docs/releases/download/v0.16.0/terraform-docs-v0.16.0-linux-amd64.tar.gz
+tar xf terraform-docs-v0.16.0-linux-amd64.tar.gz
+sudo mv terraform-docs /usr/local/bin
+```
+
+## Hook pre-commit
+
+```bash
+cat << EOF > .git/hooks/pre-commit
+#!/bin/sh
+
+# Keep module docs up to date
+target_dir=$(find . -type f -name "*.tf" -not -path "*/.terraform/*" -exec dirname {} \; | sort -u)
+for d in ${target_dir}; do
+  if terraform-docs -c .terraform-docs.yml --output-file README.md $d ; then
+    git add "./$d/README.md"
+  fi
+done
+EOF