Terraform Best Practices
Terraform consultingTwitter @antonbabenkoTerraform Weekly
עברית (Hebrew)
עברית (Hebrew)
  • ברוכים הבאים
  • מושגי מפתח
  • מבנה הקוד
  • דוגמאות למבנה קוד
    • Terragrunt
    • Terraform
      • תשתיות בקנה מידה קטן עם Terraform
      • תשתיות בקנה מידה בינוני עם Terraform
      • תשתיות בקנה מידה גדול עם Terraform
  • מוסכמות למתן שמות
  • עיצוב קוד
  • שאלות ותשובות
  • קישוריים חיצוניים
  • כתיבת קונפיגורציות של Terraform
  • סדנה
Powered by GitBook
On this page
  • תיעוד
  • ייצור תיעוד באופן אוטומטי
  • terraform-docs
  • קישוריים חיצוניים
Export as PDF

עיצוב קוד

Previousמוסכמות למתן שמותNextשאלות ותשובות

Last updated 2 years ago

  • דוגמאות ומודולי Terraform צריכים להכיל תיעוד המסביר תכונות וכיצד להשתמש בהן.

  • כל הקישורים בקבצי ה README.md צריכים להיות מוחלטים (absolute path) בכדי ש Terraform Registry יוכל להציג אותם כמו שצריך

  • התיעוד יכול לכלול דיאגרמות שנוצרו באמצעות או תרשימים שנוצרו עם

  • השתמשו ב כדי לוודא שהקוד חוקי, מעוצב כהלכה, ומתועד באופן אוטומטי לפני שידחף אל גיט ויבדק על-ידי בני אדם.

תיעוד

ייצור תיעוד באופן אוטומטי

is a framework for managing and maintaining multi-language pre-commit hooks. It is written in Python and is a powerful tool to do something automatically on a developer's machine before code is committed to a git repository. Normally, it is used to run linters and format code (see ).

התוכנה pre-commit היא מסגרת בה אפשר לנהל ולתחזק hooks לשפות רבות. היא נכתבה בפייטון והיא כלי רב עוצמה לביצוע פעולות אוטומטיות במחשב של המפתח לפני שהקוד נכנס לgit. בדר״כ היא משומשת להרצת linters ועיצוב קוד. (ראו )

עם קופניגורציית Terraform pre-commit יכול להיות משומש לעיצוב, ובדיקת תקינות הקוד וגם למען יצירת תיעוד.

בדקו את מאגר למען היכרות עם הכלי וראו איך הוא כבר משומש במקומות אחרים כגון

terraform-docs

הכלי הוא כלי ליצירת תיעוד ממודולי Terraform בתבניות פלט שונות. את/ה יכול להריץ את זה ידנית (בלי pre-commit-hooks), או להריץ את זה עם על מנת לקבל תיעוד מעודכן באופן אוטומטי.

@todo: Document module versions, release, GH actions

קישוריים חיצוניים

בלוג שנכתב ע״י :

mermid
cloudcraft.Co.
Terraform pre-commit hooks
pre-commit
supported hooks
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