git 使用規範

Gitflow工做流

Gitflow工做流借鑑自在nvie的Vincent Driessen。

Gitflow工做流定義了一個圍繞項目發佈的嚴格分支模型。雖然比功能分支工做流複雜幾分，但提供了用於一個健壯的用於管理大型項目的框架。

Gitflow工做流沒有用超出功能分支工做流的概念和命令，而是爲不一樣的分支分配一個很明確的角色，並定義分支之間如何和何時進行交互。
除了使用功能分支，在作準備、維護和記錄發佈也使用各自的分支。
固然你能夠用上功能分支工做流全部的好處：Pull Requests、隔離實驗性開發和更高效的協做。

工做方式

Gitflow工做流仍然用中央倉庫做爲全部開發者的交互中心。和其它的工做流同樣，開發者在本地工做並push分支到要中央倉庫中。

工做流中涉及到的角色介紹

功能開發者：模塊中功能的開發人員；
開發管理員：由項目模塊開發的小組長（team leader）擔當；

分支說明

名稱	說明	命名規範	命名示例	合併目標	合併操做	負責人	權限說明
master	線上穩定版本	master	master	—	—	開發管理員	master分支是保護分支，不可直接push到遠程倉master分支
release	待發布分支，下個版本需上線的版本分支，用來爲發佈新版的測試、修復作準備	release/xxx	release/v1.0.0	master/develop	merge request	功能開發者	release分支一旦創建就將獨立，不可再從其餘分支pull代碼，release分支來源develop分支
develop	當前正在開發的分支	develop	develop	master	merge request	開發管理員	由每組開發管理員負責把全部feature分支開發完成的代碼合併到develop分支
feature	功能分支，每一個功能需分別創建本身的子分支	feature/版本號-功能名	feature/v1.0.0-login	develop	merge request	功能開發者	feature分支只與develop分支交互，不能與master分支直接交互
hotfix	緊急修復分支	hotfix/xxx	hotfix/v1.0.1	master/develop	merge request	功能開發者	hotfix分支一旦創建就將獨立，不可再從其餘分支pull代碼，hotfix分支來源master分支

歷史分支

相對使用僅有的一個master分支，Gitflow工做流使用2個分支來記錄項目的歷史。master分支存儲了正式發佈的歷史，而develop分支做爲功能的集成分支。
這樣也方便master分支上的全部提交分配一個版本號。

剩下要說明的問題圍繞着這2個分支的區別展開。

功能分支

每一個新功能位於一個本身的分支，這樣能夠push到中央倉庫以備份和協做。
但功能分支不是從master分支上拉出新分支，而是使用develop分支做爲父分支。當新功能完成時，合併回develop分支。
新功能提交應該從不直接與master分支交互。

 

注意，從各類含義和目的上來看，功能分支加上develop分支就是功能分支工做流的用法。但Gitflow工做流沒有止步於此。

發佈分支

一旦develop分支上有了作一次發佈（或者說快到了既定的發佈日）的足夠功能，就從develop分支上fork一個發佈分支。
新建的分支用於開始發佈循環，因此從這個時間點開始以後新的功能不能再加到這個分支上——
這個分支只應該作Bug修復、文檔生成和其它面向發佈任務。
一旦對外發布的工做都完成了，發佈分支合併到master分支並分配一個版本號打好Tag。
另外，這些重新建發佈分支以來的作的修改要合併回develop分支。

使用一個用於發佈準備的專門分支，使得一個團隊能夠在完善當前的發佈版本的同時，另外一個團隊能夠繼續開發下個版本的功能。
這也打造定義良好的開發階段（好比，能夠很輕鬆地說，『這周咱們要作準備發佈版本4.0』，而且在倉庫的目錄結構中能夠實際看到）。

經常使用的分支約定：

用於新建發佈分支的分支: develop
用於合併的分支: master
分支命名: release-* 或 release/*

維護分支

維護分支或說是熱修復（hotfix）分支用於生成快速給產品發佈版本（production releases）打補丁，這是惟一能夠直接從master分支fork出來的分支。
修復完成，修改應該立刻合併回master分支和develop分支（當前的發佈分支），master分支應該用新的版本號打好Tag。

爲Bug修復使用專門分支，讓團隊能夠處理掉問題而不用打斷其它工做或是等待下一個發佈循環。
你能夠把維護分支想成是一個直接在master分支上處理的臨時發佈。

若是多個版本並行到test環境，怎麼解決這個問題？以下圖

示例

下面的示例演示本工做流如何用於管理單個發佈循環。假設你已經建立了一箇中央倉庫。

建立開發分支

第一步爲master分支配套一個develop分支。簡單來作能夠本地建立一個空的develop分支，push到服務器上：

git branch develop
git push -u origin develop

之後這個分支將會包含了項目的所有歷史，而master分支將只包含了部分歷史。其它開發者這時應該克隆中央倉庫，建好develop分支的跟蹤分支：

git clone ssh://user@host/path/to/repo.git git checkout -b develop origin/develop #【譯註】當沒有本地分支 develop 時， # 最後一條命令，我使用更簡單的 git checkout develop # 會自動 把 遠程分支origin/develop 檢出成 本地分支 develop 

如今每一個開發都有了這些歷史分支的本地拷貝。

小紅和小明開始開發新功能

 

這個示例中，小紅和小明開始各自的功能開發。他們須要爲各自的功能建立相應的分支。新分支不是基於master分支，而是應該基於develop分支：

git checkout -b some-feature develop

他們用老套路添加提交到各自功能分支上：編輯、暫存、提交：

git status
git add <some-file>
git commit

小紅完成功能開發

添加了提交後，小紅以爲她的功能OK了。若是團隊使用Pull Requests，這時候能夠發起一個用於合併到develop分支。
不然她能夠直接合併到她本地的develop分支後push到中央倉庫：

# 拉取遠程的develop分支，而且當前分支（本地分支some-feature）合併上遠程分支develop git pull origin develop git checkout develop # 本地分支some-feature合併上develop #【注意】這個分支已經有遠程的develop修改了，因此本地develop無需再作遠程拉取的操做 git merge some-feature git push # 刪除本地分支 git branch -d some-feature #【譯註】上面的命令註釋爲譯者添加，以方便理解 # 更多說明參見 Issue #18 

第一條命令在合併功能前確保develop分支是最新的。注意，功能決不該該直接合併到master分支。
衝突解決方法和集中式工做流同樣。

小紅開始準備發佈

這個時候小明正在實現他的功能，小紅開始準備她的第一個項目正式發佈。
像功能開發同樣，她用一個新的分支來作發佈準備。這一步也肯定了發佈的版本號：

git checkout -b release-0.1 develop 

這個分支是清理髮布、執行全部測試、更新文檔和其它爲下個發佈作準備操做的地方，像是一個專門用於改善發佈的功能分支。

只要小紅建立這個分支並push到中央倉庫，這個發佈就是功能凍結的。任何不在develop分支中的新功能都推到下個發佈循環中。

小紅完成發佈

一旦準備好了對外發布，小紅合併修改到master分支和develop分支上，刪除發佈分支。合併回develop分支很重要，由於在發佈分支中已經提交的更新須要在後面的新功能中也要是可用的。
另外，若是小紅的團隊要求Code Review，這是一個發起Pull Request的理想時機。

git checkout master
git merge release-0.1 git push git checkout develop git merge release-0.1 git push git branch -d release-0.1 

發佈分支是做爲功能開發（develop分支）和對外發布（master分支）間的緩衝。只要有合併到master分支，就應該打好Tag以方便跟蹤。

git tag -a 0.1 -m "Initial public release" master git push --tags 

Git有提供各類勾子（hook），即倉庫有事件發生時觸發執行的腳本。
能夠配置一個勾子，在你push中央倉庫的master分支時，自動構建好對外發布。

最終用戶發現Bug

對外發布後，小紅回去和小明一塊兒作下個發佈的新功能開發，直到有最終用戶開了一個Ticket抱怨當前版本的一個Bug。
爲了處理Bug，小紅（或小明）從master分支上拉出了一個維護分支，提交修改以解決問題，而後直接合並回master分支：

git checkout -b issue-#001 master # Fix the bug git checkout master git merge issue-#001 git push 

就像發佈分支，維護分支中新加這些重要修改須要包含到develop分支中，因此小紅要執行一個合併操做。而後就能夠安全地刪除這個分支了：

git checkout develop
git merge issue-#001 git push git branch -d issue-#001