ניהול מאגרי דוגמאות בהתאמה אישית ב-Cloud Code ל-VS Code

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

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

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

כשמוכנים, קל לשתף את מאגרי הדוגמאות עם הצוות. כדי להשתמש בהם, צריך להגדיר את Cloud Code ולהשתמש בכתובת ה-URL של Git של מאגר הדוגמאות. במאגרי Git פרטיים, רק חברים שיש להם גישה למאגר יכולים להשתמש בדוגמאות המותאמות אישית שמופיעות בו.

כדי לראות דוגמה להגדרה של מאגר לדוגמה, אפשר לעיין במאגר הזה.

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

מוודאים שגרסה 2.25.0 ואילך של Git מותקנת במחשב המקומי.

יצירת מאגר לדוגמה

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

1. יוצרים מאגר Git חדש.

   מאגר ה-Git שלכם יכול להתארח מרחוק או להיות פעיל במחשב המקומי. בדוגמה הזו נשתמש במאגר חדש ב-GitHub,‏ custom-sample-repo.

   

2. מוסיפים ספריות לדוגמה למאגר.

   הספריות לדוגמה יכולות להכיל כל דבר, והמיקום שלהן יכול להיות בכל מקום שתרצו במאגר. בדוגמה הזו, שתי ספריות לדוגמה, hello-world ו-kubernetes-custom-sample, נוספו ל-custom-sample-repo.

   מומלץ מאוד לכלול קובץ readme עם הוראות לשימוש מיטבי בדוגמאות המותאמות אישית.

   

3. יוצרים קובץ תיאור לדוגמה.

   קובץ תיאור לדוגמה מספק ל-Cloud Code מידע על הדוגמה כדי ליצור את האפליקציה בצורה נכונה. שם הקובץ צריך להיות .cctemplate, הוא צריך להיות ממוקם בתיקיית השורש, והסכימה שלו צריכה להיות מוגדרת בקטע סכימת קובץ תיאור לדוגמה.

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

סכימת תיאור לדוגמה

Key	תיאור	סוג
מטא-נתונים	מטא-נתונים שמשמשים את Cloud Code לקריאה. עומדת בדרישות סכימת המטא-נתונים.	מטא-נתונים
תבניות	מערך של דוגמאות שנכללות במאגר. האובייקטים במערך הזה צריכים להתאים לסכימה לדוגמה.	Array<Sample>
שם (אופציונלי)	השם של מאגר הדוגמאות.	String

דוגמה

{
   "metadata":{
      "version":"1"
   },
   "name": "My Sample Repository",
   "templates":[
      {
         "path":"/path/to/sample1_location",
         "name":"My Sample 1",
         "description":"The first sample of its name."
      },
      {
         "path":"/path/to/sample2_location",
         "name":"My Sample 2",
         "description":"The sequel."
      }
   ]
}

סכימה לדוגמה

Key	תיאור	סוג
נתיב	המיקום של הדוגמה במאגר. הנתיב הוא יחסי לשורש המאגר.	String
name	שם של דוגמה. השם מוצג בסביבת פיתוח משולבת (IDE) כשבוחרים דוגמה שאפשר לבסס עליה אפליקציה.	String
תיאור (אופציונלי)	תיאור של דוגמה. התיאור מוצג בסביבת פיתוח משולבת (IDE) כשבוחרים דוגמה שאפשר לבסס עליה אפליקציה.	String

דוגמה

{
   "path":"path/to/sample1",
   "name":"My Sample 1",
   "description":"The first sample of its name."
}

סכימת מטא-נתונים

Key	תיאור	סוג
גרסה	הגרסה של סכימת הדוגמה שבה רוצים להשתמש. הגרסה התקינה היחידה היא 1.	String

דוגמה

{
   "version":"1"
}

מחיקת מאגר דוגמאות בהתאמה אישית

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

1. בקובץ settings.json, מחפשים את localPath של רשומת הדוגמה המותאמת אישית.

   "cloudcode.customApplications": [
     {
       "repoUrl": https://github.com/GoogleCloudPlatform/cloud-code-custom-samples-example.git,
       "branchName": "",
       "localPath": "/Users/username/Library/cloud-code/custom-templates/https-github-com-google-cloud-platform-cloud-code-custom-samples-example-git"
     }
   ],
   

2. מוחקים את תיקיית התבנית בנתיב.

   הערה: ב-Mac, ‏ Library היא תיקייה מוסתרת.

3. מוחקים את הקטע של הדוגמה המותאמת אישית מהקובץ settings.json.

תמיכה

כדי לשלוח משוב, אפשר לשאול שאלה ב-Stack Overflow. אם אתם לקוחות Google Cloud, אתם יכולים לשלוח כרטיסי תמיכה דרך ערוצי התמיכה הרגילים של Google Cloud.