יצירת מאגרים מ-GitHub

מסוף Google Cloud

כדי ליצור טריגרים של GitHub באמצעות מסוף Google Cloud :

1. פותחים את הדף Triggers במסוף Google Cloud .

   פתיחת הדף Triggers

2. בוחרים את הפרויקט Google Cloud ולוחצים על Open.

3. לוחצים על Create trigger (יצירת ביטוי להפעלה).

4. מזינים את הגדרות הטריגר הבאות:

   • שם: מזינים שם לטריגר.

   • אזור: בוחרים את האזור של הטריגר.

     • אם קובץ ההגדרות של ה-build שמשויך לטריגר מציין מאגר פרטי, Cloud Build משתמש במאגר הפרטי כדי להריץ את ה-build. במקרה הזה, האזור שאתם מציינים בטריגר צריך להיות זהה לאזור שבו יצרתם את המאגר הפרטי.
     • אם קובץ התצורה של ה-build שמשויך לטריגר לא מציין מאגר פרטי, Cloud Build משתמש במאגר ברירת המחדל כדי להריץ את ה-build באותו אזור שבו מוגדר הטריגר.

   • תיאור (אופציונלי): מזינים תיאור לטריגר.

   • אירוע: בוחרים את אירוע המאגר להפעלת הטריגר.

     • Push to a branch: מגדירים את הטריגר להתחלת בנייה של קומיטים בענף מסוים.

     • Push new tag: מגדירים את הטריגר להתחלת בנייה בביצועי Commit שמכילים תג מסוים.

     • בקשת משיכה: מגדירים את הטריגר להתחלת בנייה בהתחייבויות לבקשת משיכה.

   • מקור: הגדרת פרטים על מאגר GitHub:

     • שירות מאגר: בוחרים באפשרות Cloud Build.

     • יצירת מאגר: בוחרים באפשרות דור שני כמקור.

     • מאגר: בוחרים מאגר מתוך רשימת המאגרים הזמינים.

     • Branch או Tag: מציינים ביטוי רגולרי עם ערך הענף או התג להתאמה. כאן אפשר לקרוא מידע על התחביר המקובל של ביטויים רגולריים.

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

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

       • חובה: כשמשתמש יוצר או מעדכן בקשת מיזוג, תהליכי הבנייה מופעלים רק אחרי שהבעלים או משתף הפעולה מגיבים /gcbrun לבקשת המיזוג. תהליכי build מופעלים בכל פעם שמבצעים שינוי בבקשת משיכה.

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

   • Configuration (תצורה): בוחרים את קובץ תצורת ה-build שנמצא במאגר המרוחק או יוצרים קובץ תצורת build מוטבע לשימוש ב-build.

     • סוג: בוחרים את סוג ההגדרה שרוצים להשתמש בו ב-build.
       • זיהוי אוטומטי: Cloud Build מזהה אוטומטית את סוג ההגדרה אם יש לכם קובץ cloudbuild.yaml או Dockerfile במאגר.
       • קובץ תצורת Cloud Build (yaml או json): משתמשים בקובץ תצורת build להגדרה.
       • ‫Dockerfile: משתמשים ב-Dockerfile להגדרה.
       • ‫Buildpacks: משתמשים ב-buildpacks להגדרה.

     • מיקום: מציינים את המיקום של ההגדרה.

       • מאגר: אם קובץ ההגדרות נמצא במאגר המרוחק, צריך לציין את המיקום של קובץ הגדרות הבנייה או של ספריית Dockerfile ולתת שם לתמונה שנוצרת. אם ההגדרה היא Dockerfile, אפשר גם לספק זמן קצוב לתהליך הבנייה. אחרי שמזינים את Dockerfile ואת שם התמונה, מוצגת תצוגה מקדימה של פקודת docker build שה-build יבצע.
       • בתוך השורה: אם בחרתם באפשרות קובץ הגדרות של Cloud Build (yaml או json), תוכלו לציין את הגדרות ה-build בתוך השורה. לוחצים על Open Editor כדי לכתוב את קובץ ההגדרות של ה-build בGoogle Cloud מסוף באמצעות תחביר YAML או JSON. לוחצים על Done (סיום) כדי לשמור את הגדרות ה-build.

   • משתני החלפה (אופציונלי): אם בחרתם בקובץ התצורה של Cloud Build כאפשרות להגדרת ה-build, תוכלו להגדיר בשדה הזה משתני החלפה ספציפיים לטריגר. לדוגמה, נניח שאתם יוצרים כמה טריגרים, וכל טריגר פורס את האפליקציה בסביבה ספציפית. אתם יכולים לציין שהאפליקציה שלכם נפרסת בסביבה בקובץ ההגדרות של ה-build, ואז להשתמש בשדה הזה כדי להגדיר משתני החלפה שמציינים לאיזו סביבה הטריגר הזה צריך לפרוס. מידע על ציון ערכי החלפה בקובצי הגדרות build זמין במאמר החלפת ערכים של משתנים.

   • Build logs (יומני בנייה) (אופציונלי): מסמנים את התיבה כדי לשלוח יומני בנייה ל-GitHub. במאמר הצגת יומני בנייה מוסבר איך לצפות ביומני בנייה.

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

5. לוחצים על יצירה כדי לשמור את טריגר לפיתוח גרסת Build.

כדי ליצור טריגרים של GitHub באמצעות פקודות gcloud, אפשר לעיין בgcloudפקודות ליצירת טריגר לפיתוח גרסת Build.

‫CLI של gcloud

כדי ליצור טריגרים של GitHub באמצעות פקודות gcloud, מריצים את הפקודה הבאה:

    gcloud builds triggers create github \
      --name=TRIGGER_NAME \
      --repository=projects/PROJECT_ID/locations/REGION/connections/CONNECTION_NAME/repositories/REPO_NAME \
      --branch-pattern=BRANCH_PATTERN # or --tag-pattern=TAG_PATTERN \
      --build-config=BUILD_CONFIG_FILE \
      --region=REGION \
      --service-account=SERVICE-ACCOUNT

כאשר:

• ‫TRIGGER_NAME הוא השם של הטריגר.
• ‫PROJECT_ID הוא Google Cloud מזהה הפרויקט.
• ‫REGION הוא האזור של הטריגר.
• ‫CONNECTION_NAME הוא השם של החיבור ל-GitHub.
• ‫REPO_NAME הוא שם המאגר
• ‫BRANCH_PATTERN הוא שם הענף במאגר שבו רוצים להפעיל את ה-build.
• ‫TAG_PATTERN הוא שם התג במאגר שמשמש להפעלת ה-build.
• ‫BUILD_CONFIG_FILE הוא הנתיב לקובץ התצורה של ה-build.
• ‫SERVICE-ACCOUNT הוא חשבון השירות שבו יש להשתמש לפעולות של הפעלה ובנייה.

API

כדי ליצור טריגר GitHub באמצעות ה-API, משתמשים בתבנית ה-JSON הבאה:

{
    "filename": "cloudbuild.yaml",
    "name": "curl-trigger",
    "description": "curl trigger",
    "repository_event_config": {
      "repository": "REPO_NAME",
      "repository_type": "GITHUB",
      // Field filter must be only one of the following:
      "pullRequest": "PULL_REQUEST_FILTER",
      "push": "PUSH_FILTER"
    }
}

כאשר:

• ‫REPO_NAME הוא השם של חיבור המאגר שהגדרתם ב-Cloud Build.
• ‫PULL_REQUEST_FILTER הוא מופע של PullRequestFilter, שמגדיר את המסנן שמאפשר ל-Cloud Build להפעיל בנייה כשמתבצעת ב-GitHub בקשת משיכה תואמת.
• ‫PUSH_FILTER הוא מופע של PushFilter, שמגדיר את המסנן שמאפשר ל-Cloud Build להפעיל בנייה כשמתבצעת פעולת push תואמת ב-GitHub.

מזינים את הפקודה curl הבאה במסוף:

  curl -X POST -H "Authorization: Bearer "$(gcloud auth print-access-token) -H "Content-Type: application/json; charset=utf-8" -H "x-goog-user-project: PROJECT_NUMBER" https://cloudbuild.googleapis.com/v1/projects/PROJECT_ID/triggers -d @trigger.json

כאשר:

• ‫PROJECT_NUMBER הוא מספר הפרויקט. Google Cloud
• ‫PROJECT_ID הוא Google Cloud מזהה הפרויקט.