עיצוב קוד
  • דוגמאות ומודולי Terraform צריכים להכיל תיעוד המסביר תכונות וכיצד להשתמש בהן.
  • כל הקישורים בקבצי ה README.md צריכים להיות מוחלטים (absolute path) בכדי ש Terraform Registry יוכל להציג אותם כמו שצריך
  • התיעוד יכול לכלול דיאגרמות שנוצרו באמצעות mermid או תרשימים שנוצרו עם cloudcraft.Co.
  • השתמשו ב Terraform pre-commit hooks כדי לוודא שהקוד חוקי, מעוצב כהלכה, ומתועד באופן אוטומטי לפני שידחף אל גיט ויבדק על-ידי בני אדם.

תיעוד

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

pre-commit 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 supported hooks).
התוכנה pre-commit היא מסגרת בה אפשר לנהל ולתחזק hooks לשפות רבות. היא נכתבה בפייטון והיא כלי רב עוצמה לביצוע פעולות אוטומטיות במחשב של המפתח לפני שהקוד נכנס לgit. בדר״כ היא משומשת להרצת linters ועיצוב קוד. (ראו hooks נתמכים)
עם קופניגורציית Terraform pre-commit יכול להיות משומש לעיצוב, ובדיקת תקינות הקוד וגם למען יצירת תיעוד.
בדקו את מאגר pre-commit-terraform repository למען היכרות עם הכלי וראו איך הוא כבר משומש במקומות אחרים כגון terraform-aws-vpc

terraform-docs

הכלי terraform-docs הוא כלי ליצירת תיעוד ממודולי Terraform בתבניות פלט שונות. את/ה יכול להריץ את זה ידנית (בלי pre-commit-hooks), או להריץ את זה עם pre-commit-terraform hooks על מנת לקבל תיעוד מעודכן באופן אוטומטי.
@todo: Document module versions, release, GH actions

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

Export as PDF
Copy link
Edit on GitHub
On this page
תיעוד
ייצור תיעוד באופן אוטומטי
terraform-docs
קישוריים חיצוניים