軟件版本管理文檔

1、軟件版本管理規(guī)文檔編號：ZZ-ZD-7.3-2013編制：忠林審核：批準：目錄1 弓I言31.1 目的31.2 圍31.3 術語定義31.4 版序控制記錄 41.5 版本更新記錄 42 版本管理42.1 流程圖42.2 版本命名72.2.1外部版本命名說明 72.2.2部版本命名說明 72.2.3外部版本的關系 72.3 版本升級72.3.1 版本升級原則72.3.2 新版本的發(fā)布82.4 目錄結(jié)構(gòu)92.5 文檔的存放92.5.1 文本文件的存放 92.5.2 源代碼的存放92.5.3 發(fā)行文檔的存放 102.6 權限控制管理103 備份管理103.1 源文件備份103.2 庫文件備份104

2、用戶版本管理 115 版本工具的使用 115.1 配置管理工具 115.2 SVN的使用125.2.1 常用命令125.2.2 簡單操作125.2.3 版本分支管理 13Word文檔1引言1.1目的本文檔是為規(guī)XXXX科技軟件版本管理而制定的1.2圍本文檔為系統(tǒng)軟件開發(fā)部版本管理員提供有關版本管理規(guī)的相關容，包括: 版本標識方法軟件系統(tǒng)數(shù)據(jù)的存放文檔的修改控制文檔的備份制度1.3術語定義SVNSVN是一個開源的版本控制系統(tǒng) Subversion的簡稱文檔一種數(shù)據(jù)媒體和其上所記錄的數(shù)據(jù)。配置管理標識和確定系統(tǒng)中配置項的過程，在系統(tǒng)整個生存周期控制這些項的投放和更動, 記錄并報告配置的狀態(tài)和更動要

3、求，驗證配置項的完整性和正確性。軟件配置軟件的具體形態(tài)在某時刻的瞬時影像。配置項軟件配置管理的對象稱為配置項，如：系統(tǒng)規(guī)格說明書，項目開發(fā)計劃，用戶手冊, 源碼?；€軟件生存周期中各開發(fā)階段末尾的標記，它的作用是把各階段工作的劃分更加明確 化，使本來連續(xù)的工作在這些點上斷開，使之便于檢驗和肯定階段成果。1.4版序控制記錄版序狀態(tài)擬稿審核批準發(fā)布日期1.0系統(tǒng)軟件開發(fā)部1.5版本更新記錄*A -增加 M -修改 D -刪除版本/修訂版修改頁碼修改記錄修改人日期1.0初始版本2版本管理2.1流程圖2.1.1文檔歸檔流程2.1.2文檔變更流程2.1.3代碼歸檔流程2.1.4代碼變更流程2.1.5配置

4、管理流程流程說明：1、開發(fā)人員完成所負責模塊的代碼編寫任務后，提交到項目經(jīng)理處2、項目經(jīng)理向測試部門提交測試任務3、配置管理員準備測試所需的環(huán)境4、 測試人員開展測試并實時提交 BUG5、 開發(fā)人員處理測試過程中所出現(xiàn)的BUG，并提交給測試人員進行回歸測試，直至BUG被關閉6、測試基本完成后，測試人員提交測試報告7、項目情況根據(jù)實際情況決定是否發(fā)布新的版本&配置管理員與各相關人員經(jīng)討論后確定好新版本各項信息9、配置管理員發(fā)布新版本2.2軟件版本命名2.2.1外部版本命名說明公司對外銷售、宣傳、所使用的兩位版本號， 也正是軟件產(chǎn)品登記證所使用的版本號。例：V1.02.2.2部版本命名說明部版本號

5、由四部分組成，第一個1為主版本號，第二個1為子版本號，第三個1為 階段版本號，第四部分為日期版本號加希臘字母版本號，希臘字母版本號共有5種，分別為：Base、Alpha、Beta、RC、Release 例如：1.1.1.051021_Beta 對于小項目或子 系統(tǒng)而言，可簡化為 主版本號 .次版本號 .修訂版本號，如1.0.0。*主版本號：當功能模塊有較大的變動，比如增加多個模塊或者整體架構(gòu)發(fā)生變化。 此版本號由項目決定是否修改。*子版本號：當功能有一定的增加或變化，比如增加了對權限控制、增加自定義視圖 等功能。此版本號由項目決定是否修改。*階段版本號：一般是 Bug修復或是一些小的變動，要經(jīng)

6、常發(fā)布修訂版，時間間隔 不限，修復一個嚴重的Bug即可發(fā)布一個修訂版。此版本號由項目經(jīng)理決定是否修改。*日期版本號用于記錄修改項目的當前日期，每天對項目的修改都需要更改日期版本 號。此版本號由開發(fā)人員決定是否修改。* Base版：剛出型；* Alpha版：此版本表示該軟件在此階段主要是以實現(xiàn)軟件功能為主，通常只在軟件 開發(fā)者部交流，一般而言，該版本軟件的 Bug較多，需要繼續(xù)修改。* Beta版：該版本相對于a版已有了很大的改進，消除了嚴重的錯誤，但還是存在著一些缺陷，需要經(jīng)過多次測試來進一步消除，此版本主要的修改對像是軟件的UI。* RC版：該版本已經(jīng)相當成熟了，基本上不存在導致錯誤的BUG

7、，與即將發(fā)行的正 式版相差無幾。* Release版 :該版本意味最終版本”在前面版本的一系列測試版之后，終歸會有一個正式版本，是最終交付用戶使用的一個版本。該版本有時也稱為標準版。一般情況 下，Release不會以單詞形式出現(xiàn)在軟件封面上，取而代之的是符號（R）。2.2.3外部版本的關系外部版本和容版本兩項沒有絕對關系，只有字典對應關系。軟件領用登記表在領導用，必須填外部版本和容版本兩項，都必須填寫。例：外部版本部版本序列號客戶領用人備注還原影像 存檔與通 訊系統(tǒng)V2.0V2.0.0.1（簽字）2.2.1版本升級原則版本升級應嚴格納入版本管理的控制之下。應當謹慎地控制版本的升級，保障高版 本

8、的向下兼容性，或提供嚴格定義的升級方法。在下面幾種情況下，進行版本演化和升級：1、當產(chǎn)品發(fā)生重大修改和改進時，主版本號加 1。重大修改和改進包括：1）平臺遷移；2）開發(fā)工具的遷移；3）體系結(jié)構(gòu)的變遷。2、 當產(chǎn)品發(fā)生較小的改進或修改時，次版本號可以加 1。3、對于改動量比較少的，如修改產(chǎn)品的錯誤，可升級修訂版本號。4、記錄版本升級過程。每次版本升級，都要填寫版本升級記錄表，記錄表樣例如下:版本升級記錄表主版本子系統(tǒng)名稱子系統(tǒng)版本發(fā)布日期功能變更描述發(fā)布責任人批準人備注說明：版本號：記錄當前發(fā)布的版本。發(fā)布日期：該版本批準發(fā)布的日期。修改文件：版本修改記錄文件，一般為版本修改日志。2.2.2新版

9、本的發(fā)布新版本的發(fā)布包括主版本號和次版本號的升級，一般不包括部版本號的升級。流程 如下：1、根據(jù)項目進展情況，或者根據(jù)用戶需要進行發(fā)布準備。2、將發(fā)布所需文件進行打包，放在指定目錄中，給目錄加上標簽Tag,標簽中包 含將要發(fā)布的版本信息。3、 同樣對源碼文件也要加上與版本信息相關的標簽Tag。標簽Tag命名規(guī)則如下：組成：模塊首字母+下劃線+文件類型+下劃線+主版本號+次版本號+部版本號+時間 （+下劃線+合并標記）樣例：qzcj_src_1_0_0_110923 qzcj表示采集模塊的首字母，src表示源碼，1_0_0 表示將要發(fā)布的版本號，合并標記可省略，只在有合并操作時注明，其中合并前的

10、 標記為mbe，合并后的標記為maf。2.3目錄結(jié)構(gòu)但為了能更好地管理各項目組的文檔，建議可將被管理的配置項分為三大類：文檔 類、源碼類及安裝盤類，這樣存放比較清晰，有利于版本管理，現(xiàn)將目錄結(jié)構(gòu)整理如下:根目錄一級目錄二級目錄對應配置項備注resp源碼code前置米集源碼后臺計算源碼業(yè)務應用源碼數(shù)據(jù)庫SQL文件r業(yè)務支撐公用開發(fā)包文檔doc需求文檔立項報告、需求分析、需求 記錄設計文檔軟件架構(gòu)、總體設計、概要 設計、詳細設計、界面設計數(shù)據(jù)庫文檔數(shù)據(jù)字典、數(shù)據(jù)庫搭建、備 份還原方案、PDM設計測試文檔測試計劃、測試用例、測試 報告用戶文檔用戶手冊、產(chǎn)品說明:計劃文檔項目計劃、年度月度計劃:外部接

11、口文檔標準規(guī)發(fā)布文件SETUPreleaserar文件發(fā)布文檔二級目錄中的版本指一些特殊的版本，不影響基線版本2.4文檔的存放2.4.1文本文件的存放根據(jù)各項目部自己的情況，將系統(tǒng)用戶需求記錄、總體設計文檔、詳細設計及數(shù)據(jù) 結(jié)構(gòu)文件、測試記錄、用戶手冊等放入 SVN倉庫doc目錄相應的子目錄下。2.4.2源代碼的存放源代碼包括如：h,cs, BMP，ICO等相關文件，是未經(jīng)編譯處理的、不能直接交付使用的產(chǎn)品文件以及編譯產(chǎn)品所需的文件；聯(lián)機幫助文件HLP在未生成HLP文件之前的DOC, RTF等格式的文檔也視為源代碼。各子系統(tǒng)當前的程序源文件放入 SVN倉庫code目錄相應的bb目錄下，對于一個

12、 子系統(tǒng)又分多個分子系統(tǒng)的情況，應在該目錄下分別建立幾個相應的子目錄。243發(fā)行文檔的存放發(fā)行文檔是指產(chǎn)品交付用戶使用所必須的文件。包括：產(chǎn)品可執(zhí)行文件，用戶使用 說明書，聯(lián)機幫助（HLP）；資源文件（BMP，ICO等），環(huán)境配置文件等。以上文檔作為制作發(fā)行盤的素材，放在SVN倉庫發(fā)布文件目錄的Release目錄之下, 制作好的發(fā)行盤放在發(fā)布文件的 Setup目錄。2.5權限控制管理為保障文檔的安全性，一致性，以及防止意外修改，必須對不同的文檔設置不同的 訪問權限。文檔權限類別：無任何權限，只讀權限，所有權限。文檔類別：設計文檔，源碼，發(fā)行文檔。用戶類別：開發(fā)人員、測試人員、項目經(jīng)理、配置管理

13、員等。為了控制不同的使用權限，根據(jù)要求在服務器上分別建立不同的用戶，針對不同的 配置項所在目錄分配不同的權限。為了便于管理，應以表格的形式列出人員與管理對象的訪問關系（用戶權限清單） 詳見系統(tǒng)部SVN權限配置。3備份管理為了保證文檔的最大可恢復性，要隨時及定期地進行備份工作3.1源文件備份開發(fā)人員每天都要將自已當日修改的源文件提交（commit）至SVN倉庫。3.2庫文件備份為防止服務器出現(xiàn)異常，需對服務器上的SVN倉庫文件進行備份，目前采用的方案 如下：工作日備份：每個工作日將原本位于 D盤的倉庫文件在H盤上備份一份，當D盤 倉庫出現(xiàn)異常時，用戶可把 ROOT目錄修改至H盤備份的目錄，再進行

14、更新操作。每周備份：每周五下班時將H盤備份文件異地備份至其它IP （目前備份在192.168.1.68上）。每月備份：每個月底將最新版本備份至光盤。4用戶版本管理為了更好地管理源程序，應為每一用戶建立一個用戶版本文件，該文件應包含以下 容：用戶編號：001用戶名稱： xxxxxxxx軟件版本號：2.0.0.0開始使用時間：2010.8.11聯(lián)系人：xx聯(lián)系戶程序更改日志樣例如下:更改 時間版本號修改模 塊名稱變更原因變更概述軟件位置變更 人員備注說明：1）用戶購買軟件時要為該用戶建立一個包含上述容的一個用戶版本文件，并填寫 有關數(shù)據(jù)。2）用戶進行版本更新時要求填寫該文

15、件的版本變更記錄，用以反映用戶版本的變 更情況。5版本工具的使用5.1配置管理工具開發(fā)部采用SVN1行配置管理，SVN是一個C/S系統(tǒng)，多個開發(fā)人員通過一個中心 版本控制系統(tǒng)來記錄文件版本，從而達到保證文件同步的目的。目前采用的 SVN服艮務端為 VisualSVN-2.6.4，客戶端為 TortoiseSVN-1.82247085.2 SVN的使用5.2.1常用命令英文命令中文命令操作、說明備注Checkout提取/取出將文件下載到本地目錄第一次下載目錄用Commit提交將改動過的文件提交到版本庫每次對文件更新后使用Update更新將文件冋步到最新版本獲取最新版本Tag標簽給某個版本添加一個

16、標記符號便于合并分支與主線Branch分支創(chuàng)建某個文件的分支建立特殊版本時用到Merge合并將分支文件（或主文件）的更改合并到主文件 （或分支文件）diff比較不同比較任意兩個版本間的不冋Revers ionGraph版本分支圖查看文件各版本（包括分支文件）的走向圖查詢各個版本及TagHistory歷史查看文件各個版本更新歷史查詢版本詳細信息5.2.2簡單操作文件提?。撼醮问褂眯鑼⒃次募膫}庫提取出來，執(zhí)行checkout命令將庫文件提取至本地相應定時更新：開發(fā)人員每天早上對源代碼或文件進行更新操作（右鍵執(zhí)行update操作）。實時更新：某一開發(fā)人員提交更改后，可通知其它人員進行更新操作。實時

17、提交：對某一文件進行更改完成后，執(zhí)行commit命令將更改提交至倉庫，更改前先進行更新操作，如多個人員對同一文件同時進行操作，會產(chǎn)生沖突，這時需要對沖突進行處理。沖突處理：提交產(chǎn)生沖突時，先對文件進行同步（即更新）操作，之后會產(chǎn)生一個合并文件， 前為當前服務器最新版本修改的容，找到最近提交該文件的同事，進行協(xié)商后對源文件進行修改并提交。創(chuàng)建分支/標簽：右鍵菜單中選擇Branch 或Tag找開創(chuàng)建對話框，輸入Branch名或Tag名，選中Create new branch / Create new tag,點擊 OK 即可。查看版本/歷史：文件（非文件夾）右健菜單中選擇 Revision Gra

18、ph.或History.可查看 該文件的版本更新記錄或歷史信息。523版本分支管理我們把一個項目的主要開發(fā)過程稱作開發(fā)基線。當某一個特殊事件發(fā)生的時候，例 如，有一個用戶有特殊的需求，于是就從這個開發(fā)基線里分離出來一個叉，以滿足用戶 特殊的需求，這個叉有它自己的發(fā)展方向，這就是分支。 分支/- 開發(fā)基線上面這個點，代表開發(fā)基線的最新版本，如果從開發(fā)基線建立分支來進行定制開發(fā)， 開發(fā)基線和分支就可以有各自的發(fā)展方向。如果有需要，分支的代碼可以重新合并到開 發(fā)基線中，開發(fā)基線的代碼也可以合并到分支代碼中。假設在我們的home目錄下的proj目錄就是我們的工程。下面具體看一下，如何建 立分支：1、 當我們要在基線某個版本建立分支時，先在基線該版本上創(chuàng)建一個標簽（Tag）， 就是上圖中的黑點。這樣做是便于以后主干可以重新回到分支創(chuàng)建時的狀態(tài)。2、創(chuàng)建分支：右健單擊該目錄，選擇 Branch，指定分支名，點擊 0K即可。 新建分支的版本號呈偶數(shù)序列遞增，如在基線版本 1.5上創(chuàng)建兩個分支，則分支版本分 別為1.521和1.541 ，分支的后續(xù)版本分別為1.522和1.542。3、在另外的目錄下執(zhí)行checkout命令，把剛才建立的分支提取出