תיעוד

הגדרות שחרור

הגדר את הסביבות שדרכן עוברת גרסה, את הכללים לכל אחת מהן, ואת האופן שבו הפריסות מתחילות ומדווחות על עצמן.

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

סביבות
לאן נכנס שחרור? הוסיפו נקודות עצירה וסדרו אותן.
כללי אישור
מה חייב להתקיים קודם? אישורים, תפקידים, רשימת בדיקה וכללי תיקון מהיר לכל סביבה.
צינור פריסה
מי מבצע פריסה, וכיצד CoRoid מקבל משוב? הפייפליין שלכם או CoRoid מפעילים אותו; אסימון דיווח מאפשר ל-CI/CD לאשר את התוצאה.
ניהול גרסאות
לאיזו גרסה זו שייכת? מקורות הגרסאות, מה שהתהליך מקבל, וכיצד CoRoid בודק מה בדיוק רץ.
שחרורים → הגדרות שחרור: בחר פרויקט, לאחר מכן ארבעה מסכים – שאלה אחת בכל מסך.

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

סביבות

לאן נכנסת הגרסה, ובאיזה סדר?

כל פרויקט מתחיל עם סביבת ייצור. הוסיפו את נקודות הפריסה האחרות שבהן אתם מפרסמים, כגון סביבת בדיקות או QA, באמצעות הוספת סביבה. תנו שם לכל אחד מהם. CoRoid מציע מפתח על בסיס השם, למשל staging. CI/CD משתמש במפתח הזה כשהוא מדווח על פריסה, לכן שמרו על יציבותו לאחר שהפייפליינים מתחילים להשתמש בו.

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

כללי אישור

מה חייב להתקיים לפני שגרסה תתפרסם כאן?

בחרו את הסביבה בראש הדף. הכללים הם לפי סביבה, כך שסביבת בדיקות יכולה להיות קלה יותר וסביבת ייצור – קפדנית יותר.

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

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

פייפליין פריסה

מי מבצע את הפריסה, וכיצד CoRoid יודע מה קרה?

בחרו את הסביבה בראש הדף, ולאחר מכן בחרו כיצד הפריסות מתחילות:

  • הפייפליין שלי מפרסם באופן אוטומטי: שמרו על התהליך הנוכחי שלכם. CoRoid רושם פריסות כאשר CI/CD מדווח עליהן, או כאשר בעלים או מנהל רושמים פריסה חיצונית בדף השחרור.
  • CoRoid מפעיל תהליך עבודה של GitHub Actions או CoRoid מפעיל צינור עבודה של GitLab CI/CD: מוצג כאשר מאגר הקוד של הפרויקט נמצא אצל אותו ספק. הזינו את הענף או התג שמצביע על קובץ השחרור, קובץ התהליך של GitHub, והשם המדויק של המשימה שמבצעת את הפריסה. CoRoid בודק את ה־ref לפני שהוא מתחיל את הריצה ובודק את המשימה המסוימת לפני שהוא מאשר הצלחה.

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

גרסאות

לאיזו גרסה שייכת הפריסה הזו, וכיצד הבנייה מקבלת אותה?

בחרו מאין מגיע מספר הגרסה של כל שחרור: CoRoid מציע את הבא, CoRoid קורא אותו מקובץ במאגר הקוד, או שהצינור שלכם מדווח עליו. לכל שחרור יש גם מספר בנייה שרק עולה. המסך מציג את הערכים ש־CoRoid מעביר לצינור שלכם, יכול לפתוח עבודה חדשה עם בקשה להוסיף אותם לבנייה שלכם, ולקבל כתובת URL של גרסה לכל סביבה כדי ש־CoRoid יוכל לאשר מה רץ בכל אחת מהן. הכנסת הגרסה לבנייה שלך מכיל את הפרטים וההוראות המדויקות עבור בניית אפליקציות לרשת, שרתים, Docker, iOS ואנדרואיד.

העברת הגדרות בין ארגונים

ייצוא וה imports של הגדרות כוללים את הסביבות, סדרן, תצורת הפייפליין, גרסאות, כתובות URL של גרסאות וכללי פרסום, כולל כללי תיקון מהיר. טוקני דיווח ומספרי בנייה אינם נכללים בייצוא. יש ליצור טוקנים חדשים לאחר import; לכל פרויקט יש מספרי בנייה משלו.