התעלמות מקבצים וספריות ב- git (.gitignore)

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

קובץ ה- .gitignore מציין אילו קבצים שלא .gitignore Git להתעלם.

מאילו קבצים יש להתעלם?

קבצים שהתעלמו הם בדרך כלל קבצים ספציפיים לפלטפורמה או קבצים שנוצרו אוטומטית ממערכות ה- build. כמה דוגמאות נפוצות כוללות:

• קבצי זמן קבצים כמו קבצי יומן, נעילה, מטמון או קבצים זמניים. קבצים עם מידע רגיש, כגון סיסמאות או מפתחות API. קוד מורכב, כמו ספריות.class או.o. תלות, כגון /vendor או /node_modules node_modules. ספריות לבנות., כגון /public , /out או /dist קבצי מערכת כמו .DS_Store או Thumbs.db IDE או קבצי תצורה של עורך טקסט.

.גיטיגנור

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

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

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

כללי התעלמות אישיים

יש להגדיר דפוסים הספציפיים למאגר המקומי שלך ולא צריכים להפיץ אותם למאגרים אחרים, יש לקבוע בקובץ .git/info/exclude .

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

גלובלי

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

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

לדוגמה, כדי להגדיר ~/.gitignore_global כקובץ ה- Git להתעלמות הגלובלי, תבצע את הפעולות הבאות:

1. צור את הקובץ:

   touch ~/.gitignore_global

   הוסף את הקובץ לתצורת Git:

   git config --global core.excludesfile ~/.gitignore_global

   פתח את הקובץ עם עורך הטקסט שלך והוסף אליו את הכללים שלך.

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

התעלמות מקבצים שהוקמו בעבר

ניתן לעקוב אחר הקבצים בעותק העבודה שלך או לא למעקב.

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

git rm --cached filename

האפשרות - --cached אומרת ל- git לא למחוק את הקובץ מעץ העבודה אלא רק להסיר אותו מהאינדקס.

להסרת ספרייה רקורסיבית, השתמש באפשרות -r :

git rm --cached filename

בעת מחיקת קבצים רקורסיבית, השתמש באפשרות -n שתבצע "הפעלה יבשה" ותראה לך אילו קבצים יימחקו:

git rm -r -n directory

ניפוי באגים. קובץ .gitignore

לפעמים זה יכול להיות מאתגר לקבוע מדוע מתעלמים מקובץ מסוים, במיוחד כשאתה משתמש בכמה קבצי .gitignore או בתבניות מורכבות. זה המקום בו הפקודה של git check-ignore עם אפשרות -v , המורה ל- git להציג פרטים על דפוס ההתאמה, מועילה.

לדוגמה, כדי לבדוק מדוע www/yarn.lock מקובץ www/yarn.lock תפעל:

git check-ignore -v www/yarn.lock

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

www/.gitignore:31:/yarn.lock www/yarn.lock

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

הצגת כל הקבצים שהתעלמו מהם

פקודת git status עם האפשרות --ignored מציגה רשימה של כל הקבצים שהתעלמו מהם:

git status --ignored

סיכום

קובץ ה- .gitignore מאפשר לבצע אי הכללה של קבצים להיבדק במאגר. הקובץ מכיל דפוסי גלוש המתארים אילו קבצים וספריות יש להתעלם.

gitignore.io הוא שירות מקוון המאפשר לך ליצור קבצי .gitignore עבור מערכת ההפעלה, שפת התכנות שלך או IDE.