კოდის სტილი
- ტერაფორმის მოდულები და მაგალითები უნდა შეიცავდეს დოკუმენტაციას, ფუნქციონალების გამოყენების შესახებ.
- ყველა ბმული README.md ფაილებში უნდა იყოს სრული, რათა Terraform Registry ვებსაიტმა ისინი აჩვენოს სწორად.
- დოკუმენტაცია შესაძლოა მოიცავდეს mermaid-ით შექმნილ დიაგრამებს და cloudcraft.co-ით შექმნილ blueprint-ებს.
- იმისათვის რომ დავრწმუნდეთ კოდის არის ვალიდური, სათანადო ფორმატში და ავტომატურად დოკუმენტირებული, უნდა გამოვიყენოთ Terraform pre-commit hooks, სანამ კოდი გადავა Git-ზე და გახდება საჯარო.
pre-commit არის ფრეიმვორქი მრავალენოვანი pre-commit hooks-ების სამართავად და შესანარჩუნებლად. ის დაწერილია python-ზე და არის ძლიერი ხელსაწყო დეველოპერების კომპიუტერებზე კოდის git რეპოზიტორიაში გადატანამდე მოხდეს შემოწმება typo-ებზე. ჩვეულებრივ, ის გამოიყენება linter-ების გასაშვებად და კოდის ფორმატირებისთვის (იხილეთ supported hooks).
ტერაფორმის კონფიგურაციით
pre-commit შეიძლება გამოყენებულ იქნას კოდის ფორმატირებისა და ვალიდაციისთვ ის, ასევე დოკუმენტაციის განახლებისთვის.შეამოწმეთ pre-commit-terraform repository და უკვე არსებული საცავები, რათა უკეთესად გაიგოთ მისი არსი.
terraform-docs არის ხელსაწყო, რომლის მეშვეობითაც ტერაფორმის მოდულებიდან გენერირდება დოკუმენტაც ია სხვადასხვა ფორმატში. შეგიძლიათ ის გაუშვათ მანუალურად (pre-commit hooks-ის გამოყენების გარეშე) ან გამოიყენოთ pre-commit-terraform hooks თუ გსურთ რომ დოკუმენტაცია განახლდეს ავტომატურად.
@todo: Document module versions, release, GH actions
Last modified 6mo ago