ניקיונות גיט (פוסט קצר לפסח)

אני לא מחשיב את עצמי מומחה לגיט. מעטים מאוד הם בעצם כאלו.

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

גיט הוא מספיק מורכב כדי שלא נוכל לעבוד איתו על "טייס אוטומטי" 100% מהזמן.

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

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

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


קצת רקע אישי הקשור לגיט:

• אני עובד עם Github (כמו הרוב), מה שאומר שאני לא נוהג לבצע פעולות ב remote מתוך command line. 
• אני עובד עם IntelliJ, מה שאומר שאני שחלק מהפעולות אני מעדיף לעשות ב GUI. בעיקר: 
• git log, git blame, git diff 
• ל intelliJ יש גם יכולת שימושית בשם Git Shelf - יכולת מקבילה ל git stash המאפשרת לאחסן כמות לא מוגבלת של "stashes" (ה IDE פשוט מאכסון את ה diffs בתיקיה נפרדת). 
• אני עובד עם Ohh my Zsh מה שמאפשר לי כמה קיצורים ו autocomplete שלא נמצאים ב shell הסטנדרטי. זה כנראה לא משפיע הרבה על מה שאכתוב כאן - אקפיד להשתמש בשם הפקודה המלאה ולא בקיצורים.

ניקוי קבצים

אתחיל בתסריט של ניקוי קבצים:

עבדתם על משהו, ואז מישהו ביקש מכם code review על branch אחר ו/או מישהו ניגש אליכם ושאל איך כדאי לעשות משהו - והראתם לו כמה שינויים בקוד.

עכשיו אתם רוצים לחזור לעבודה, אבל יש לכם כמה קבצים ושינויים שאתם לא זקוקים להם. 

ראיתי שלא פעם אנשים מסתבכים עם הסיטואציה הזו וצריכים "לחשוב".

הנה כמה פעולות שימושיות "להשתחרר" מהמצב:

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

Test-Delete untracked files: git clean -n

Delete untracked files (not staging): git clean -f

clean היא פקודה שמטרתה לנקות קבצים שאינם באינדקס (קרי: לא tracked). הגרסה n- מציגה רשימה של קבצים למחיקה, ו f- מוחקת אותם בפועל.


גרסה מעט אגרסיבית, אבל יעילה לנקות את כל השינויים המקומיים:

. git add ואז
git reset --hard

זוהי הדרך "אוטומטית" (ללא צורך בחשיבה) לנקות את כל השינויים המקומיים. 
קודם אנחנו מוסיפים את כל השינויים ב workspace לאינדקס (קבצים ששונו, קבצים חדשים, קבצים שנמחקו) ואז מבקשים מגיט לאפס את האינדקס משינויים, לדרוס הכל (hard--).

הסבר קצר: לפקודה git reset יש 2 צורות:

• הסרה של קובץ / path מהאינדקס. ההופכי ל git add. הווריאציה הזו פועלת כאשר מצוין path (למשל: .)
• איפוס ה branch הנוכחי (HEAD) למצב של commit מסוים - כאשר לא מצוין path.

קצת מבלבל שיש 2 פעולות עם אופי שונה תחת אותה הפקודה!

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


לכאורה ניתן לבצע את פעולת "revert" מתוך ה IDE אבל בכמה מקרים (למשל: קבצים חדשים) - יידרשו עוד כמה צעדים ידניים. גישת ה add-reset היא המהירה ביותר (עד כמה שידוע לי).

התחרטתי!

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


התחלתי merge אבל הוא הסתבך לי

git merge --abort

מבטל את ה merge וחוזר לשלב שהיה לפניו.
בד"כ הפקודה הבאה תהיה שוב <git merge <some branch - אבל הפעם אנו יודעים טוב יותר מה מצפה לנו, ונעשה אותו בצורה נכונה יותר.

עשיתי commit ל master או ל branch אחר שלא התכוונתי

git reset HEAD~1

הנה עוד שימוש בווריאציה השנייה של git reset - איפוס ה HEAD ל commit מסוים. 
על הפקודה הזו ניתן לחשוב כמו HEAD = HEAD-1:

• החזר את ה branch ל commit אחד אחורה (ניתן להחליף את המספר 1 בכל מספר אחר).
• כל השינויים שנכללו ב commits ש"בוטלו" - יועברו ל working directory.

מכאן אני יכול לבצע:

git checkout desired_branch

. git add

"..." git commit -m 

והנה כל השינויים נמצאים כ commit ב branch שאליו התכוונתי.


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

בגדול, כל פעם ש git log מעורב - יש יתרון לממשקי GUI ע"פ ה command line (לטעמי).
בהפעלת הפעולה, IntelliJ פותח 4 אופציות. האופציה שציינתי נקראת "mixed" - אבל אתם יכולים לבחור בכל אופציה שנשמעת לכם הגיונית ורצויה.

לנקות branches

branches באים הולכים: נוצרים, נושאים שינויי קוד, ואז ממורג'ג'ים ל branch אחר - ואז אין צורך בהם.
אם אתם מיישמים Continuous Integration - רוב הסיכויים שייצרו כמה branches חדשים כל יום.
מכירים את המצב שיש לכם 5 או יותר branches מקומיים שאתם לא בטוחים מה המצב שלהם?
אתם רוצים לעשות push ולמרגג' את מה שנותן, למחוק אותם - ואז להתחיל עבודה חדשה.

מסובך? 

העצה הכי טובה שיש לי היא למחוק בזוגות, branches מקומיים ומרוחקים - מיד לאחר ביצוע merge ב github.

git branch -d branch_name :

1. ימחק branch שהוא fully merged, ל repository המרוחק, או המקומי
2. ימחק (עם warning) את ה branch אם הוא push ל remote (ואין לו עדכונים).
3. לא ימחק אם אין remote tracking ו/או יש שינויים מקומיים שלא עודכנו ל remote.

זוהי פקודה בטוחה יחסית. אם המקרה השני קרה - אפשר לחזור ממנו בעזרת git checkout ל branch שנמחק. הקוד נמצא ב remote.
את ה branch ב Github - מוחקים בעזרת ה UI.

אפשר לאטמט את התהליך המקומי ולהפעיל פקודה כמו:

git branch | grep -v "master" | xargs git branch -d 

עוברים על כל ה branches המקומיים

grep -v יוציא ה master מהרשימה (אותו לא נרצה למחוק)

xargs מפעילה את הפקודה שאחריה עם פרמטר של מה שמגיע מה pipe (כלומר: stdin). כלומר: תנסה למחוק את כל ה branches, מלבד master, בצורה "בטוחה".

עדיין צריך לשים לב ל warnings ולהחזיר (בעזרת checkout) את branches שלא התכוונו למחוק.

יהיו עדיין branches שהפקודה לא תמחק. ירשם error בנוסח "the branch ... is not fully merged". אלו:

• branches עם commits מקומיים - אולי שכחנו לעדכן ל remote? אולי ויתרנו על הקוד הזה?
• branches ללא remote tracking (מעולם לא עשינו push ו/או הפעלנו git fetch --prune או פקודה דומה).

אז מה עושים עם ה branches שלא נמחקו עם git branch -d?
כאן יש עוד עבודה ידנית. עדיין לא מצאתי דרך פשוטה יותר:

• להיכנס לכל branch
• לבדוק את ה log לראות אילו commits קיימים
• אם זה לא מספיק - לעשות diff ולראות מה השינויים בקבצים. האם נרצה אותה?
• לדחוף (git push) ו/או למחק (git branch -D branch_name) את ה branch.

כרגיל, כאשר יש עבודה עם git log - יש יתרון גדול לעשות את העבודה ב GUI.


שווה אולי להזכיר שיש גם פקודות כגון:

git branch --merged branch_name

המספקת לנו רשימה של branches שממורג'ג'ים ל branch_name.
כאשר רוב ה merges נעשים ב remote (למשל: GitHub) - היא פחות שימושית

ניתן גם לבדוק אלו branches שיש להם remote tracking (להלן r-) מורג'ג'ו ל master המרוחק:

git branch -r --merged origin/master

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


---

טיפ קטן למשתמשי Ohh my Zsh:
לעתים המלצות ה autocomplete ל gco (קרי git checkout) כוללות כל מיני branches ישנים.

git fetch -p שזה בעצם git fetch --prune

מנקה את ה metadata על branches שהם כבר לא remote tracked - מה שמנקה הצעות autocomplete לא רלוונטיות, אל הניקוי הזה גם גורם לפקודת git branch -d לכישלונות כי היא לא יודעת מה מצב ה branch המרוחק.

הטיפ: לקרוא ל git fetch -p רק במצב שכל ה branches המקומיים נקיים או שאין לכם בכלל branches מקומיים. זה יחסוך לכם כאבי ראש.

---

טיפ קטן לסיום:

איך רואים ב IntelliJ השוואה כמו זו של Github?

ה compare של Github נראה קצר יותר וממוקד יותר מ compare ב IDE?

אתם מוצאים את עצמכם עושים git push רק בכדי ליהנות מה compare של Github ולצפות בהתקדמות שלכם בכתיבת קוד?

אתם יכולים לבצע השוואה דומה גם ב IntelliJ.

אני מניח שאתם נוהגים לעשות compare מתוך התפריט בפינה התחתונה של ה IDE:

ואז compare ל branch המוביל:

עד כאן טוב ויפה, אבל כנראה שהפעולה הבאה שלכם היא לבחור ב tab של files (מסומן ב x אדום):

התוצאה תהיה לראות את כל השינויים מול ה master - גם כאלו שלא אתם הכנסתם, אלא אתם גוררים עם ה branch. זה לא יעיל.

במקום זה, תבחרו את רשימת ה commits שלכם (1), ואז תקבלו בצד ימין את רשימת הקבצים בהם נעשו שינויים כחלק מה commits שלכם (2).

הנה עוד כמה settings ב view של ה compare שידמו יותר ל Github:

זה אולי יחסוך לחסוך לכם כמה גישות לגיטהאב + יש יתרון ממשי ל compare בתוך ה IDE. 
למשל: היכולת לבצע שינויים במקום על מה שלא נראה לכם.



זהו לסיום.
מקווה שהפוסט יהיה שימושי לכמה אנשים.

שיהיה בהצלחה!

---

לינקים רלוונטיים

https://zippyzsquirrel.github.io/squirrel-u/1_SquirrelU/4_GitHub/1_introToGitAndGitHub/ - מדריך הכולל גם פרטים כיצד לעבוד עם כלי ה git של IntelliJ.