Terraform Best Practices
Terraform consultingTwitter @antonbabenkoTerraform Weekly
हिंदी (Hindi)
हिंदी (Hindi)
  • स्वागतम्
  • मुख्य अवधारणाएं
  • कोड संरचना
  • कोड संरचना उदाहरण
    • टेराग्रंट
    • टेराफ़ॉर्म
      • टेराफॉर्म के साथ छोटे आकार का बुनियादी ढांचा
      • टेराफॉर्म के साथ मध्यम आकार का बुनियादी ढांचा
      • टेराफॉर्म के साथ बड़े आकार का बुनियादी ढांचा
  • नामकरण की परंपरा
  • कोड स्टाइलिंग
  • सामान्य प्रश्न
  • संदर्भ
  • टेराफ़ॉर्म कॉन्फ़िगरेशन लिखना
  • कार्यशाला
Powered by GitBook
On this page
  • प्रलेखन
  • स्वचालित रूप से उत्पन्न दस्तावेज
  • terraform-docs
  • साधन
Export as PDF

कोड स्टाइलिंग

Previousनामकरण की परंपराNextसामान्य प्रश्न

Last updated 2 years ago

  • उदाहरण और टेराफॉर्म मॉड्यूल में सुविधाओं की व्याख्या करने वाले दस्तावेज और उनका उपयोग कैसे करना चाहिए।

  • टेराफॉर्म रजिस्ट्री वेबसाइट को सही ढंग से दिखाने के लिए README.md फाइलों के सभी लिंक पूर्ण होने चाहिए।

  • दस्तावेज़ीकरण में के साथ बनाए गए आरेख और के साथ बनाए गए ब्लूप्रिंट शामिल हो सकते हैं।

  • यह सुनिश्चित करने के लिए का उपयोग करें कि कोड मान्य है, ठीक से स्वरूपित है, और स्वचालित रूप से इसे git में धकेलने और मनुष्यों द्वारा समीक्षा करने से पहले प्रलेखित किया गया है।

प्रलेखन

स्वचालित रूप से उत्पन्न दस्तावेज

बहु-भाषा प्री-कमिट हुक के प्रबंधन और रखरखाव के लिए एक ढांचा है। यह Python में लिखा गया है और एक गिट रिपॉजिटरी के लिए कोड प्रतिबद्ध होने से पहले एक डेवलपर की मशीन पर स्वचालित रूप से कुछ करने के लिए एक शक्तिशाली उपकरण है। आम तौर पर, इसका उपयोग लिंटर चलाने और कोड को प्रारूपित करने के लिए किया जाता है (see ).

टेराफॉर्म कॉन्फ़िगरेशन के साथ pre-commit का उपयोग कोड को प्रारूपित करने और मान्य करने के साथ-साथ प्रलेखन को अपडेट करने के लिए किया जा सकता है.

इसके साथ खुद को परिचित करने के लिए भंडार देखें, और मौजूदा भंडार (उदाहरण के लिए, )) जहां यह पहले से ही उपयोग किया जाता है।

terraform-docs

एक ऐसा उपकरण है जो विभिन्न आउटपुट स्वरूपों में टेराफॉर्म मॉड्यूल से प्रलेखन तैयार करता है। आप इसे मैन्युअल रूप से चला सकते हैं (प्री-कमिट हुक के बिना), or use दस्तावेज़ को स्वचालित रूप से अपडेट करने के लिए.

@todo: Document module versions, release, GH actions

साधन

Blog post by :

mermaid
cloudcraft.co
Terraform pre-commit hooks
pre-commit
supported hooks
pre-commit-terraform repository
terraform-aws-vpc
terraform-docs
pre-commit-terraform hooks
pre-commit framework homepage
Collection of git hooks for Terraform to be used with pre-commit framework
Dean Wilson
pre-commit hooks and terraform - a safety net for your repositories