קישור אל GitHub

בדף הזה מוסבר איך ליצור חיבורים ל-GitHub ואיך ליצור קישורים למאגרי GitHub. אפשר לבצע את המשימות האלה באמצעות מסוף Google Cloud או Google Cloud CLI.

ההוראות האלה מיועדות למפתחי אפליקציות, לאדמינים של פלטפורמות ולמנהלי אבטחה שרוצים להשתמש במאגרי קוד מקור של GitHub עם Google.

לדוגמה, אתם יכולים לקבל הצעות לתכנות מ-Gemini Code Assist, שמותאמות לבסיס הקוד שלכם, או להשתמש במאגרי GitHub המקושרים כדי לפתח אפליקציות אינטרנט באמצעות Firebase App Hosting.

מידע נוסף על Developer Connect זמין במאמר סקירה כללית של Developer Connect.

לפני שמתחילים

נכנסים לחשבון Google.

אם עדיין אין חשבון, יוצרים חשבון חדש.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Developer Connect API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Developer Connect API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

הפעלת Developer Connect מפעילה גם את Secret Manager API.

1. ודאו שיש לכם גישה לחשבון ב-GitHub.

   כדי לשמור על אבטחת העבודה של הצוות, מומלץ לבצע את המשימות במדריך הזה באמצעות חשבון בוט או חשבון משותף של הצוות, ולא באמצעות חשבון אישי.

2. צריך לוודא שיש לכם מאגר ב-GitHub או הרשאות אדמין במאגר משותף.
3. אופציונלי: יוצרים מפתח הצפנה בניהול הלקוח (CMEK) להצפנת סודות האימות שנוצרים על ידי Developer Connect.
4. אופציונלי: כדי להשתמש בהוראות של שורת הפקודה במדריך הזה, מבצעים את השלבים הבאים:
   1. מתקינים את Google Cloud CLI. אם כבר התקנתם את ה-CLI של gcloud בעבר, צריך לוודא שפועלת אצלכם הגרסה העדכנית ביותר של gcloud components update.
   2. יוצרים חשבון שירות של Developer Connect על ידי הרצת הפקודה הבאה, כש-PROJECT_ID הוא Google Cloud מזהה הפרויקט:

              gcloud beta services identity create \
                  --service=developerconnect.googleapis.com \
                  --project=PROJECT_ID
              

התפקידים הנדרשים

כדי לקבל את ההרשאות שדרושות ליצירת חיבורים וקישורים, צריך לבקש מהאדמין להקצות לכם את תפקידי ה-IAM הבאים:

• אם אתם לא הבעלים של הפרויקט: אדמין של Developer Connect (roles/developerconnect.admin) בחשבון המשתמש שלכם.
• אם אתם מתכננים להשתמש ב-CMEK כדי להצפין את הסודות שנוצרים על ידי Developer Connect: Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter) בחשבון השירות של Secret Manager.
• אם אתם מתכננים להשתמש ב-CLI של gcloud כדי לבצע את השלבים במדריך הזה: התפקיד Secret Manager Admin (roles/secretmanager.admin) בחשבון השירות של Developer Connect.
• אם אתם מתכננים להשתמש במסוף כדי לבצע את השלבים במדריך הזה: אדמין IAM של פרויקט (roles/resourcemanager.projectIamAdmin) בחשבון המשתמש שלכם. Google Cloud

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

יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.

הערה: אם יש לכם את התפקיד 'אדמין IAM בפרויקט' (roles/resourcemanager.projectIamAdmin), מסוף Google Cloud יכול להעניק אוטומטית את ההרשאות הנדרשות בשמכם. אם האדמין לא מאפשר לכם לקבל את התפקיד 'אדמין IAM בפרויקט', אתם יכולים לבקש ממנו להקצות לכם את התפקיד 'אדמין של Secret Manager' (roles/secretmanager.admin) בחשבון השירות של Developer Connect (service-{projectNumber}@gcp-sa-devconnect.iam.gserviceaccount.com).

יצירת חיבור

בקטע הזה מוסבר איך ליצור חיבור בין Developer Connect לבין GitHub. אם אתם משתמשים במסוף Google Cloud , תוכלו גם להתחיל להוסיף קישורים למאגרי מידע אחרי שתסיימו להגדיר את החיבור.

כדי ליצור חיבור חדש ל-GitHub, בוחרים באחת מהאפשרויות הבאות:

המסוף

כדי ליצור חיבור, מבצעים את השלבים הבאים:

1. פותחים את Developer Connect במסוף Google Cloud .

   כניסה אל Developer Connect

   בדף מאגרי Git ב-Developer Connect.

   • אם מוצגת רשימה של ספקי ניהול קוד מקור: בוחרים ספק ניהול קוד מקור כדי להגדיר את החיבור הראשון. לוחצים על Connect (חיבור) בכרטיס GitHub.

   • אם מוצגת טבלה עם רשימה של חיבורים קיימים: מגדירים את ספק ניהול קוד המקור על ידי לחיצה על יצירת חיבור > GitHub.

     ייפתח הדף Create Connection.

2. בשדה Region, בוחרים אזור למשאבי הקישור.

   1. בשדה Name (שם), מזינים שם לקישור החדש.

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

   חיבורים ל-GitHub שנוצרו באמצעות Google Cloud המסוף עומדים בדרישות של שמירת נתונים במדינה מסוימת אם מסמנים את תיבת הסימון הזו כשיוצרים את החיבור. כשעושים את זה, Developer Connect יוצר אפליקציית GitHub

   כשיוצרים חיבורים ל-GitHub באמצעות Google Cloud CLI, החיבורים האלה לא עומדים בדרישות של שמירת נתונים. כל סוגי החיבורים האחרים תואמים לדרישות בנושא מיקום הנתונים.

4. לוחצים על הצגת הגדרות נוספות כדי לראות הגדרות אופציונליות.

   1. אופציונלי: בקטע Encryption, בוחרים מפתח CMEK כדי להצפין סודות של Secret Manager שנוצרו על ידי Developer Connect.

   2. אופציונלי: כברירת מחדל, Developer Connect יכול לשמש כשרת proxy לקריאות Git ל-GitHub. כדי להשבית את האפשרות הזו, מבטלים את הסימון בתיבה Enable Developer Connect proxy.

5. לוחצים על Continue.

6. לוחצים על I understand and continue (הבנתי ואני רוצה להמשיך) כדי להסכים לשיתוף של טוקן GitHub OAuth עם Developer Connect ולאחסון שלו ב-Secret Manager.

7. אם מוצגת בקשה להיכנס לחשבון ב-GitHub, מזינים את פרטי הכניסה.

8. לוחצים על Authorize Developer Connect כדי לאפשר לאפליקציית Google Developer Connect לגשת לחשבון GitHub.

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

9. אם בחרתם באפשרות הפעלת חיבור שעומד בדרישות של מיקום הנתונים, תתבקשו ליצור אפליקציית GitHub.

   1. מזינים שם לאפליקציית GitHub.

   2. לוחצים על Create GitHub app (יצירת אפליקציית GitHub).

   3. בוחרים את היעד שבו רוצים להתקין את האפליקציה (חשבון GitHub או ארגון).

   4. בוחרים את המאגרים שבהם רוצים להתקין את אפליקציית GitHub, או באפשרות All repositories (כל המאגרים), ולוחצים על Install (התקנה).

   5. בוחרים את המאגרים לקשר לחיבור הזה ולוחצים על אישור.

   6. לוחצים על קישור.

‫GitHub יוצר טוקן, ו-Developer Connect מאחסן אותו בGoogle Cloud פרויקט כסוד ב-Secret Manager. מידע נוסף על ניהול סודות זמין במאמר בנושא הצגת פרטי סודות.

אם הפעלתם את התכונה 'מיקום הנתונים', עכשיו יש לכם אפליקציית GitHub שאפשר לנהל אותה בלחיצה על Manage installation בדף Connection details.

הגדרת החיבור

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

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

בתיבת הדו-שיח Developer Connect, מבצעים את הפעולות הבאות:

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

1. בוחרים את החשבון ב-GitHub שבו רוצים להשתמש.

2. בוחרים מאגר אחד או יותר שרוצים לתת גישה אליהם.

אם מופיעה בקשה להשתמש מחדש בהתקנה קיימת של אפליקציה, צריך לבחור איפה להגדיר את האפליקציה על ידי השלמת השלבים הבאים:

1. לוחצים על GitHub Account כדי לראות את החשבונות שבהם מותקנת האפליקציה Google Developer Connect. אם אתם רואים את החשבון שבו אתם רוצים להשתמש, לוחצים על אישור כדי לבחור אותו.

2. אם החשבון שבו רוצים להשתמש לא מופיע, צריך לבצע את הפעולות הבאות:

   1. בוחרים באפשרות Install the GitHub App on another GitHub account (התקנת אפליקציית GitHub בחשבון אחר ב-GitHub) ולוחצים על Confirm (אישור).

   2. פועלים לפי השלבים ב-GitHub כדי לאשר את התקנת האפליקציה.

   3. בוחרים מאגר אחד או יותר שרוצים לתת גישה אליהם.

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

אחרי שיוצרים את הקישור, מופיע הדף Link repositories (קישור מאגרי מידע).

כדי לקשר מאגרי מידע לחיבור:

1. ברשימת המאגרים הזמינים, בוחרים את המאגרים שרוצים להשתמש בהם.

2. לוחצים על OK.

3. לוחצים על קישור.

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

אם אתם מגדירים את Gemini Code Assist, ממשיכים בתהליך לפי השלבים במאמר הגדרה ושימוש ב-Gemini Code Assist עיגון בקוד של הארגון.

gcloud

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

כדי ליצור חיבור, מבצעים את השלבים הבאים:

1. מריצים את הפקודה gcloud developer-connect connections create כדי ליצור חיבור ל-GitHub:

   gcloud developer-connect connections create CONNECTION_NAME \
       --location=REGION \
       --github-config-app=APP_TYPE \
       --git-proxy-config-enabled
   

   מחליפים את מה שכתוב בשדות הבאים:

   • ‫CONNECTION_NAME: השם של החיבור.
   • ‫REGION: האזור של החיבור.

   • ‫APP_TYPE: סוג האפליקציה להתקנה ב-GitHub. אחת מהאפשרויות הבאות:

     FIREBASE לשימוש עם Firebase App Hosting

     ‫DATAFORM לשימוש עם Dataform

     ‫GEMINI_CODE_ASSIST לשימוש עם Gemini Code Assist

     ‫DEVELOPER_CONNECT לשימוש בכל שאר המקרים

   • ‫--git-proxy-config-enabled: דגל אופציונלי שמאפשר ל-Developer Connect לפעול כפרוקסי לקריאות Git ל-GitHub. היכולת הזו נמצאת בגרסת טרום-השקה.

   נוצר שם לחיבור.

2. כדי לסיים את יצירת החיבור, צריך להתקין את אפליקציית GitHub של Developer Connect. מריצים את הפקודה הבאה כדי לקבל את ה-URI להתקנת האפליקציה:

   gcloud developer-connect connections describe CONNECTION_NAME \
       --location=REGION
   

   מחליפים את מה שכתוב בשדות הבאים:

   • ‫CONNECTION_NAME: השם של החיבור.
   • ‫REGION: האזור של החיבור.

   הכלי Developer Connect מחזיר קישור להשלמת השלבים הבאים בחלון דפדפן. מעתיקים את הקישור.

3. פותחים את הקישור בדפדפן אינטרנט.

4. לוחצים על I understand and continue (הבנתי ואני רוצה להמשיך) כדי להסכים לשיתוף של טוקן GitHub OAuth עם Developer Connect ולאחסון שלו ב-Secret Manager.

5. אם מוצגת בקשה להיכנס לחשבון ב-GitHub, מזינים את פרטי הכניסה.

6. לוחצים על Authorize Developer Connect כדי לאפשר לאפליקציית Google Developer Connect לגשת לחשבון GitHub.

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

‫GitHub יוצר טוקן, ו-Developer Connect מאחסן אותו בGoogle Cloud פרויקט כסוד ב-Secret Manager. מידע נוסף על ניהול סודות זמין במאמר בנושא הצגת פרטי סודות.

אם הפעלתם חיבור שעומד בדרישות של שמירת נתונים במדינה מסוימת, עכשיו יש לכם אפליקציית GitHub שתוכלו לנהל בלחיצה על Manage installation בדף Connection details.

הגדרת החיבור

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

בתיבת הדו-שיח Developer Connect, מבצעים את הפעולות הבאות:

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

1. בוחרים את החשבון ב-GitHub שבו רוצים להשתמש.

2. בוחרים מאגר אחד או יותר שרוצים לתת גישה אליהם.

אם מופיעה בקשה להשתמש מחדש בהתקנה קיימת של אפליקציה, צריך לבחור איפה להגדיר את האפליקציה על ידי השלמת השלבים הבאים:

1. לוחצים על GitHub Account כדי לראות את החשבונות שבהם מותקנת האפליקציה Google Developer Connect. אם אתם רואים את החשבון שבו אתם רוצים להשתמש, לוחצים על אישור כדי לבחור אותו.

2. אם החשבון שבו רוצים להשתמש לא מופיע, צריך לבצע את הפעולות הבאות:

   1. בוחרים באפשרות Install the GitHub App on another GitHub account (התקנת אפליקציית GitHub בחשבון אחר ב-GitHub) ולוחצים על Confirm (אישור).

   2. פועלים לפי השלבים ב-GitHub כדי לאשר את התקנת האפליקציה.

   3. בוחרים מאגר אחד או יותר שרוצים לתת גישה אליהם.

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

אימות החיבור

מריצים את הפקודה הבאה כדי לוודא שנוצר חיבור ל-GitHub:

gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

מחליפים את מה שכתוב בשדות הבאים:

• ‫CONNECTION_NAME: השם של החיבור.
• ‫REGION: האזור של החיבור.

‫Developer Connect מחזיר סטטוס בשדה installationState. אם הערך של השדה הזה הוא COMPLETE, התקנת האפליקציה הושלמה. אחרת, Developer Connect מחזיר URI כדי להפנות אתכם להגדרה בדפדפן.

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

הוספת קישורים למאגרים לחיבורים קיימים

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

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

המסוף

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

   פותחים את הדף Repositories

2. לוחצים על קישור מאגר.

   נפתח החלונית Link Git repositories (קישור מאגרי Git).

3. ברשימת החיבורים, בוחרים חיבור.

4. לוחצים על Continue.

5. ברשימת המאגרים, בוחרים את המאגרים שרוצים לקשר.

6. לוחצים על יצירה.

הכלי Developer Connect יוצר את הקישורים למאגר ומציג אותם במסוף Google Cloud .

gcloud

מריצים את הפקודה הבאה:

gcloud developer-connect connections git-repository-links create REPO_NAME \
    --clone-uri=REPO_URI \
    --connection=CONNECTION_NAME \
    --location=REGION

מחליפים את מה שכתוב בשדות הבאים:

• ‫REPO_NAME: שם המאגר.
• ‫REPO_URI: הקישור למאגר GitHub. לדוגמה, https://github.com/cloud-build/test-repo.git.
• ‫CONNECTION_NAME: השם של החיבור.
• ‫REGION: האזור של החיבור.

הקישורים למאגר נוצרים על ידי Developer Connect.

כדי לכלול ברשימה את המאגרים המקושרים, מריצים את הפקודה developer-connect connections git-repository-links list.

אם אתם מגדירים את Gemini Code Assist, ממשיכים בתהליך לפי השלבים במאמר הגדרה ושימוש ב-Gemini Code Assist עיגון בקוד של הארגון.

שיתוף נתונים

תוכן מ Google Cloud מקורות שמקושרים לחיבור הזה עשוי להיות מועבר אל GitHub. ההצהרה הזו חלה על כל המשאבים הקיימים והעתידיים שמשתמשים בחיבור הזה. כדי להפסיק את שיתוף המידע עם GitHub, צריך למחוק את החיבורים של Developer Connect ב Google Cloud מסוף או ב-CLI של gcloud, ולבטל את הגישה ב-GitHub.

המאמרים הבאים

• משלימים את ההגדרה של עיגון בקוד של הארגון ב-Gemini Code Assist
• איך Gemini Code Assist עוזר לכם להאיץ את פיתוח התוכנה
• אפשר לעיין בשילובים אחרים שזמינים דרך Developer Connect.