開發經驗漫談 -- Git在開發流程中的運用

這幾期和大家分享下我自己在開發時的一些經驗，這次來說說關於Git在開發流程中的運用。

目的

1. 保持提交歷史整潔，俗稱的一條線提交。
2. 讓專案程式碼有跡可循，提供清晰的開發歷程，亦稱：取其精華，去其糟粕。
3. 幫助大家養成好的程式碼開發習慣，即：如何更好地和他人合作。
4. 提供一個思路，讓大家更深刻的理解git。

請先花時間閱讀

1. 如果你沒有接觸過git，請先閱讀：http://git-scm.com/book/zh/v2
2. 必讀：https://www.atlassian.com/git/tutorials/merging-vs-rebasing

示例系統

我們使用一個簡單的專案作為示例來進行說明。

該系統由使用者管理模組和角色管理模組組成，該專案已經完成了角色模組的開發，現在在開發使用者模組。

開發流程

第一步：獲取專案程式碼

ligang@vm-xubuntu ~/devspace $ git clone /home/ligang/repository/gitflow.git
Cloning into gitflow...
remote: Counting objects: 6, done.
remote: Compressing objects: 100% (2/2), done.
remote: Total 6 (delta 0), reused 0 (delta 0)
Receiving objects: 100% (6/6), done.

當前的提交歷史如下：

建立遠端合作分支

我們把這個分支命名為user_admin

ligang@vm-xubuntu ~/devspace/gitflow $ git push -u origin user_admin
Total 0 (delta 0), reused 0 (delta 0)
To /home/ligang/repository/gitflow.git
 * [new branch]      user_admin -> user_admin
Branch user_admin set up to track remote branch user_admin from origin.

操作完成後，提交歷史如下：

說明：合作開發user_admin模組的同學，會在這個分支上合併彼此的程式碼。

第三步：建立個人分支（真正的開發工作在這裡進行）

我們把這個分支命名為：user_admin_ligang

ligang@vm-xubuntu ~/devspace/gitflow $ git push -u origin user_admin_ligang
Total 0 (delta 0), reused 0 (delta 0)
To /home/ligang/repository/gitflow.git
 * [new branch]      user_admin_ligang -> user_admin_ligang
Branch user_admin_ligang set up to track remote branch user_admin_ligang from origin.

請注意：

1. 此分支是在遠端合作分支（user_admin）的基礎上建立的。
2. 此分支只可合併遠端合作分支，不可以直接合並master。

分支合併流程

假設在user_admin_ligang的個人分支中已經完成了開發，現在需要把這部分程式碼提交給被人使用，那麼請按照如下方式操作：

假設開發完成後的提交歷史如下：

第一步：整理個人開發分支中待合併的提交，去掉無用的，僅保留有用的

• 切到user_admin_ligang分支

ligang@vm-xubuntu  ~/devspace/gitflow $ git checkout user_admin_ligang
ligang@vm-xubuntu  ~/devspace/gitflow $ git branch
  master
  user_admin
* user_admin_ligang
ligang@vm-xubuntu  ~/devspace/gitflow $

• 查詢newbase

在這個清理過程中，我需要清理掉tmp1和tmp2這2個臨時提交，所以newbase就是init，這裡獲得它的版本號：

• 執行清理

這一步是不可逆的，請謹慎操作，亦可先備份。

這裡按照提示，我們編輯rebase資訊:

儲存退出，由於上面我們告訴rebase我們要重新編輯提交資訊（r,reword），這裡會進入提交資訊編輯介面，我們修改最終提交資訊如下：

儲存退出，清理過程結束，這裡再次檢視提交歷史：

這裡可以看到，tmp1和tmp2已經被清理掉了，最終的done2是一個全新的提交。

第二步：合併個人分支到遠端合作分支

請確保此時只有你一個人操作遠端合作分支

• 更新本地遠端合作分支到最新

ligang@vm-xubuntu ~/devspace/gitflow $ git checkout user_admin
Switched to branch 'user_admin'
ligang@vm-xubuntu ~/devspace/gitflow $ git pull origin user_admin
From /home/ligang/repository/gitflow
 * branch            user_admin -> FETCH_HEAD
Already up to date.

• 切到user_admin_ligang分支

ligang@vm-xubuntu ~/devspace/gitflow $ git checkout user_admin_ligang
Switched to branch 'user_admin_ligang'

• 衍合個人開發分支

衍合前

衍合

ligang@vm-xubuntu ~/devspace/gitflow $ git rebase user_admin
First, rewinding head to replay your work on top of it...
Applying: done2
Using index info to reconstruct a base tree...
M   show.txt
Falling back to patching base and 3-way merge...
Auto-merging show.txt
CONFLICT (content): Merge conflict in show.txt
error: Failed to merge in the changes.
Patch failed at 0001 done2
Use 'git am --show-current-patch' to see the failed patch

Resolve all conflicts manually, mark them as resolved with
"git add/rm <conflicted_files>", then run "git rebase --continue".
You can instead skip this commit: run "git rebase --skip".
To abort and get back to the state before "git rebase", run "git rebase --abort".

這裡有可能需要解決衝突，再continue完成整個衍合過程。

衍合後

• 合併入遠端合作分支

ligang@vm-xubuntu ~/devspace/gitflow $ git merge user_admin_ligang
Updating add0d89..9ed757b
Fast-forward
 show.txt | 1 +
 1 file changed, 1 insertion(+)

合併後的提交歷史

刪除個人開發分支

ligang@vm-xubuntu ~/devspace/gitflow $ git branch -d user_admin_ligang
Deleted branch user_admin_ligang (was 9ed757b).
ligang@vm-xubuntu ~/devspace/gitflow $ git push origin :user_admin_ligang
To /home/ligang/repository/gitflow.git
 - [deleted]         user_admin_ligang

合併到主幹

操作前確認

進行這一步操作前，請確認已經滿足如下條件：

1. 請確認待合併的遠端合作分支上的開發目標已全部完成。
2. 請確認即將把程式碼合併入主幹進行釋出上線。

如不能全部滿足上述所有條件，請不要進行此操作。

合併入主幹

請確保此時只有你一個人操作遠端分支及主幹

• 更新本地主幹到最新

ligang@vm-xubuntu ~/devspace/gitflow $ git checkout master
Switched to branch 'master'
Your branch is up to date with 'origin/master'.
ligang@vm-xubuntu ~/devspace/gitflow $ git pull
Already up to date.

• 切到user_admin分支

ligang@vm-xubuntu ~/devspace/gitflow $ git checkout user_admin
Switched to branch 'user_admin'

• 衍合遠端合作分支

ligang@vm-xubuntu ~/devspace/gitflow $ git rebase master
Current branch user_admin is up to date.

這裡的過程和遠端合作分支衍合時是一樣的，有可能需要解決衝突，再continue完成整個衍合過程。

• 合併入主幹

ligang@vm-xubuntu ~/devspace/gitflow $ git checkout master
Switched to branch 'master'
Your branch is up to date with 'origin/master'.
ligang@vm-xubuntu ~/devspace/gitflow $ git merge user_admin
Updating 73180c1..9ed757b
Fast-forward
 show.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

• 刪除遠端合作分支

ligang@vm-xubuntu ~/devspace/gitflow $ git branch -d user_admin
Deleted branch user_admin (was 9ed757b).
ligang@vm-xubuntu ~/devspace/gitflow $ git push origin :user_admin
To /home/ligang/repository/gitflow.git
 - [deleted]         user_admin

最終的提交歷史