תיעוד

כיצד Coroid מאמת את עבודתו באופן עצמאי

מדוע pull request מֵאת Coroid מגיע כבר מנוהל, ומה בדיוק מעיד עליו כל שלב של אימות.

כל קובץ pull request מֵאֶת Coroid עובר תהליך אימות לפני שאתם רואים אותו. פרק זה מסביר מה המשמעות של כך וכיצד להגדיר זאת.

השכבות

תהליך האימות אינו אחיד. ישנן ארבע שכבות, כל אחת עונה על שאלה שונה.

סט הבדיקות שלכם. זהו האות החזק ביותר הזמין, מכיוון שהוא כבר משקף את מה שצוותכם קבע כחשוב. Coroid מריץ אותו בסביבת עבודה נקייה עבור כל משימה.

שערי איכות. בדיקות המוגדרות על פי מדיניות – כיסוי קוד, linting, סריקת אבטחה, בדיקות דפדפן, וה בדיקת גלובליזציה עבור פרויקטים רב-לשוניים. שערים חוסמים עוצרים את המשימה; שערים מייעצים רושמים ממצא ומאפשרים המשך. ראו מדיניות איכות ושערי איכות.

סקירה. סוכן הסקירה קורא את ה־diff המושלם ומפיק ממצאים. ממצאים שניתן לתקן יוחזרו למפתח כעבודה נוספת; השאר יצורפו ל־pull request.

ראיות. פריסות תצוגה מקדימה, תוצאות סריקה ושינויים בכיסוי הקוד מצורפים ישירות ל־pull request, כך שהאימות מגיע יחד עם הקוד. ראו ראיות לסקירה.

  1. חבילת הבדיקות שלךהאם השינוי פוגע במה שכבר עובד?
  2. שערי איכותהאם הוא עומד בתקנים שמגדירה המדיניות שלכם?
  3. סקירההאם קורא קפדני של ה־diff יקבל אותו?
  4. ראיותהאם הראיות מצורפות לצד הקוד?
  5. הסקירה שלךהאם זה השינוי הנכון לבצע?

כל שכבה אוטומטית פועלת לפני ש־pull request נוצר, כך שכישלונות חוזרים כעבודה מחדש במסגרת הריצה.

כל שכבה אוטומטית עונה על שאלה שונה. אף אחת מהן אינה קובעת אם זו הייתה הבחירה הנכונה לבנייה; האחריות נותרת בידיכם.

מה שתהליך זה מוכיח ומה לא

תהליך האימות מאשר שהשינוי עושה את מה שהוא אמור לעשות, שאינו שובר את מה שהיה קיים, ושהוא עומד בתקנים שקבעתם.

הוא אכן אינו מאשר שהשינוי הוא הדבר הנכון לפתח. זו המטרה של קריטריוני הקבלה ב־ מפרט ושל תהליך הסקירה שלכם.

שינוי יכול לעבור את כל השכבות ועדיין להיות שגוי. שמירה על ההבחנה הזו חדה היא מה שהופך את שאר התהליך לאמין – ברגע שהאימות מוצג כשיפוט, אנשים מפסיקים לבצע סקירה.

המטרה של הרצתו מראש

כל שכבה פועלת לפני ש־pull request נוצר, כך שכישלונות חוזרים כעבודה נוספת בתוך אותו ריצוי ולא כ־pull request שתידחה.

זה זול יותר לכשל בסביבת העבודה מאשר על המסך שלכם. הסקירה שלכם צריכה להיות ה־ אנושית בדיקה ראשונה, לא המבט הראשון.

מאיפה להתחיל

אם אתם מגדירים זאת בפעם הראשונה:

  1. ודאו שסט הבדיקות שלכם פועל – ראו הגדרת בנייה ובדיקה. שום דבר אחר אינו רלוונטי אם זה אינו תקין.
  2. הגדירו מדיניות ברירת מחדל לארגון ברמת ה־ סטנדרט ולא ברמת הקפדנית ביותר שלכם.
  3. חברו את ספקי הראיות שאתם כבר משתמשים בהם.
  4. הוסיפו שערים אחד אחד, תחילה אלו המייעצים.

בפרק זה