add doc terraform
0 parents
Showing
1 changed file
with
34 additions
and
0 deletions
generate_readme.py
0 → 100644
1 | import os | ||
2 | import subprocess | ||
3 | |||
4 | # Récupérer le nom du module (nom du dossier actuel) | ||
5 | module_name = os.path.basename(os.getcwd()) | ||
6 | |||
7 | # Vérifier si terraform-docs est installé | ||
8 | try: | ||
9 | subprocess.run(["terraform-docs", "--version"], check=True, stdout=subprocess.PIPE) | ||
10 | except FileNotFoundError: | ||
11 | print("❌ terraform-docs n'est pas installé. Installez-le d'abord.") | ||
12 | exit(1) | ||
13 | |||
14 | # Exécuter terraform-docs et récupérer la sortie | ||
15 | terraform_docs_output = subprocess.run(["terraform-docs", "markdown", "."], capture_output=True, text=True) | ||
16 | |||
17 | # Conditionner le comportement pour le README.md racine | ||
18 | if module_name == "racine": # Changez "racine" par le nom du dossier racine | ||
19 | # Pour la racine, on génère simplement un README propre sans les balises | ||
20 | readme_content = f"# Projet Terraform\n\n{terraform_docs_output.stdout}" | ||
21 | else: | ||
22 | # Pour les autres modules, on génère avec les balises | ||
23 | readme_content = f"""<!-- BEGIN_TF_DOCS --> | ||
24 | # Module: {module_name} | ||
25 | |||
26 | {terraform_docs_output.stdout} | ||
27 | <!-- END_TF_DOCS --> | ||
28 | """ | ||
29 | |||
30 | # Écrire dans le fichier README.md | ||
31 | with open("README.md", "w", encoding="utf-8") as readme_file: | ||
32 | readme_file.write(readme_content) | ||
33 | |||
34 | print(f"✅ README.md généré pour le module {module_name} !") |
-
Please register or sign in to post a comment