כיצד ניתן להעביר פרוייקט קיים ל- GitHub?

הושלמה

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

מדוע לעבור ל- GitHub?

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

בקרת גירסאות

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

שמור את הקוד שלך בענן

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

הערה

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

שיתוף פעולה

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

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

מעבר ל- GitHub

שיקולי תכנון

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

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

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

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

כשיטת עבודה מומלצת, מאגרי GitHub צריכים להיות מוגבלים לקבצים הדרושים לבניית פרוייקטים. הימנע מביצוע קבצים בינאריים גדולים כגון ממצאי Build. קבצים בינאריים כגון גליונות אלקטרוניים ומצגות מתאימים יותר למעקב בפורטלים שמבינים כיצד לשרת אותם ולבצע בהם גירסאות כראוי. אם עליך לעדכן קבצים בינאריים גדולים, שקול להשתמש בסיומת Git LFS Git LFS (אחסון קבצים גדולים).

יצירת קבצי Git חשובים כגון .gitignore

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

[Bb]in/

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

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

קובץ	תכלית
README.md	דף היעד של מדריך הכתובות. דף זה מעובד כאשר מדריך הכתובות שלו מוצג ב- GitHub.
LICENSE.md	הרשיון שתחתיו מופיע הקוד.
CONTRIBUTING.md	מסביר כיצד המשתמשים צריכים לתרום לפרוייקט, כגון ציפיות בקשת משיכה.
SECURITY.md	מסביר את מדיניות האבטחה עבור הפרוייקט. מספק הדרכה למשתמשים המעוניינים לשלוח קוד רגיש הקשור לאבטחה או משוב שלא אמור להיחשף בפומבי לפני שימוענו.

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

ייבוא הפרוייקט שלך ל- GitHub

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

הכלי GitHub מעביר דואג לכל השאר.