תיעוד

סקירת ראיות

תצוגות מקדימות, תוצאות סריקה, כיסוי קוד ותוצאות בדיקות מצורפות ל-pull request שהן מתארות.

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

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

מה ניתן לצרף?

Coroid משתלב עם ספקים ממספר קטגוריות:

קטגוריהספקים
מבוססי Gitסביבות Actions של GitHub, אפליקציות סקירה של GitLab
איחסון סטטיVercel, Netlify, Cloudflare Pages, AWS Amplify
תצוגות מקדימות של אפליקציות מלאותRender, Railway, Heroku Review Apps, Fly.io, Northflank, Qovery, Porter
הפצת אפליקציות ניידותExpo EAS, TestFlight, בדיקות פנימיות ב-Google Play
סקירה וסריקהCodeRabbit, Qodo / סוכן PR, Greptile, Cursor Bugbot, SonarQube Cloud, Snyk, Semgrep
כיסוי קוד ובדיקות ויזואליותCodecov, Chromatic, Percy
בדיקות E2E וניטורCypress Cloud, Checkly, Maestro, BrowserStack
מותאם אישיתWebhook ראיות מותאם אישית

בסך הכול שלושים ואחד ספקים. Webhook הראיות המותאם אישית מכסה כל דבר שאינו מופיע ברשימה.

כל ספק מציין אילו סוגי ראיות הוא יכול לספק – תצוגה מקדימה באינטרנט, בנייה לאפליקציה ניידת, סקירת AI, סריקת אבטחה, כיסוי קוד, בדיקה ויזואלית, בדיקות E2E וביצועים – וכיצד Coroid מאחסן אותן, בין אם מהממשק של Git, מפלטי CI או על ידי קריאה ישירה מ-API של הספק.

ככל הנראה כבר יש לכם את רוב אלו.

זו בדיוק המטרה. צוותים המאמצים את Coroid כבר מחזיקים בדרך כלל בתצוגות מקדימות, סורק ודוחות כיסוי קוד. ראיות לסקירה מחברות בין הכלים הקיימים במקום להחליף אותם.

הגדירו ספקים בהגדרות החיבור של הארגון; הראיות יצורפו אז אוטומטית לבקשות משיכה ש-Coroid פותח.

ראיות ושערים

ראיות ו שערים קשורים זה לזה אך שונים:

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

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

ראיות לאחר מיזוג

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

בחירת מה לצרף

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

צרפו רק את מה שמשנה את ההחלטה:

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