• בלוג
  • עמוד 145
  • איך לקבל Badge מדליק שהבדיקות בפרויקט שלך עוברות

איך לקבל Badge מדליק שהבדיקות בפרויקט שלך עוברות

06/10/2020

אז כתבתם בדיקות אוטומטיות לפרויקט - מזל טוב! בטח שמתם לב שיש פרויקטים בגיטהאב שמציגים Badge מדליק כזה שאומר שהבדיקות עברו (או שלפרויקט יש תיעוד, או שהפרויקט נחמד או כל דבר אחר שאתם רוצים לכתוב שם) ושאלתם את עצמכם, איך גם אני מקבל כזה Badge יפה להראות לחברים?

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

  1. צרו פרויקט עם בדיקות אוטומטיות ודרך אוטומטית להריץ אותן בתוך Github Actions. אני יצרתי לדוגמה פרויקט Python שמשתמש ב Pytest בקישור הזה https://github.com/ynonp/pytest-webinar-demos/.

  2. בשביל לגרום לבדיקות האוטומטיות לרוץ בכל קומיט יצרתי Workflow בתיקיית .github/workflows. בתוך קובץ ה workflow יש שדה בשם name שאותו צריך לזכור. אם אתם לא בטוחים לגבי מבנה הפרויקט או תוכן קובץ ה workflow אפשר בכיף לקחת מהדוגמה שלי במאגר.

  3. אחרי שהבדיקות רצות באופן אוטומטי גיטהאב יוצר קובץ SVG עם המילה Passing (במקרה הטוב) או Failing (במקרה הרע). הנתיב לקובץ האוטומטי הזה מורכב מהנתיב למאגר שלכם, אחרי זה המילה workflows ואז שם ה workflow (זה שזכרנו בסעיף הקודם). במקרה שלי הנתיב הוא: https://github.com/ynonp/pytest-webinar-demos/workflows/tests/badge.svg.

  4. עכשיו כל מה שנשאר זה לצרף את התמונה לתוך ה readme.md של המאגר, אצלי הוספתי את השורה הבאה לקובץ ה readme.md:

![Tests](https://github.com/ynonp/pytest-webinar-demos/workflows/tests/badge.svg)

עכשיו בכל קומיט גיטהאב יריץ מחדש את הבדיקות ויחשב מחדש את ה SVG, וכל פעם שהבדיקות עוברות נוכל לראות את זה בקובץ ה readme כשמסתכלים על המאגר.