軟件版本管理規(guī)定

1、軟件版本管理規(guī)定TYYGROUP system office room TYYUA16H-TYY-TYYYUA8Q8-軟件版本管理規(guī)范系統(tǒng)軟件開發(fā)部2011-9-20目錄1 引言目的范圍術(shù)語定義版序控制記錄版本更新記錄2 版本管理流程圖版本命名版本升級版本升級原則新版本的發(fā)布目錄結(jié)構(gòu)文檔的存放文本文件的存放源代碼的存放發(fā)行文檔的存放7權(quán)限控制管理3 備份管理源文件備份庫文件備份4 用戶版本管理5 版本工具的使用配置管埋工具CVS的使用常用命令簡單操作版本分支管理1引言1.1目的本文檔是為規(guī)范XXXXXX有限公司軟件版本管理而制定的。L2范圍本文檔為系統(tǒng)軟件開發(fā)部版本管理員提供有關(guān)版本管理規(guī)范的

2、相關(guān)內(nèi)容，包括： 版本標(biāo)識方法軟件系統(tǒng)數(shù)據(jù)的存放文檔的修改控制文檔的備份制度1. 3術(shù)語定義CVSCVS是一個(gè)開源的版本控制系統(tǒng)Concurrent Versions System的簡稱文檔一種數(shù)據(jù)媒體和其上所記錄的數(shù)據(jù)。配置管理標(biāo)識和確定系統(tǒng)中配置項(xiàng)的過程，在系統(tǒng)整個(gè)生存周期內(nèi)控制這些項(xiàng)的投放和更動， 記錄并報(bào)告配置的狀態(tài)和更動要求，驗(yàn)證配置項(xiàng)的完整性和正確性。軟件配置軟件的具體形態(tài)在某時(shí)刻的瞬時(shí)影像。配置項(xiàng)軟件配置管理的對象稱為配置項(xiàng)，如：系統(tǒng)規(guī)格說明書，項(xiàng)目開發(fā)計(jì)劃，用戶手冊，源碼?；€軟件生存周期中各開發(fā)階段末尾的標(biāo)記，它的作用是把各階段工作的劃分更加明確化， 使本來連續(xù)的工作在這些點(diǎn)

3、上斷開，使之便于檢驗(yàn)和肯定階段成果。1. 4版序控制記錄版序狀 態(tài)擬稿審核批準(zhǔn)發(fā)布日期系統(tǒng)軟件開發(fā)部1. 5版本更新記錄*A -增加M -修改D -刪除版本/修訂版修改頁 碼修改記錄修改人日期初始版本2版本管理2. 1流程圖2. 1.1 文檔歸檔流程2. 1.3代碼歸檔流程開發(fā)人員測試人員配置管理員代碼變更流程2. 1.4流程說明:1、開發(fā)人員完成所負(fù)責(zé)模塊的代碼編寫任務(wù)后，提交到項(xiàng)目經(jīng)理處2、項(xiàng)目經(jīng)理向測試部門提交測試任務(wù)3、配置管理員準(zhǔn)備測試所需的環(huán)境4、測試人員開展測試并實(shí)時(shí)提交BUG5、開發(fā)人員處理測試過程中所出現(xiàn)的BUG,并提交給測試人員進(jìn)行回歸測試，直至BUG 被關(guān)閉6、測試基本完

4、成后，測試人員提交測試報(bào)告7、項(xiàng)目情況根據(jù)實(shí)際情況決定是否發(fā)布新的版本8、配置管理員與各相關(guān)人員經(jīng)討論后確定好新版本各項(xiàng)信息9、配置管理員發(fā)布新版本2. 2軟件版本命名軟件版本號由四部分組成，第一個(gè)1為主版本號，第二個(gè)1為子版本號，第三個(gè)1為 階段版本號，第四部分為日期版本號加希臘字母版本號，希臘字母版本號共有5種，分別 為：Alpha、Beta、RC、Release。例如：Beta。對于小項(xiàng)目或子系統(tǒng)而言，可簡化為主 版本號.次版本號.修訂版本號，如。* 主版本號：當(dāng)功能模塊有較大的變動，比如增加多個(gè)模塊或者整體架構(gòu)發(fā)生變化。 此版本號由項(xiàng)目決定是否修改。* 子版本號：當(dāng)功能有一定的增加或變

5、化，比如增加了對權(quán)限控制、增加自定義視圖 等功能。此版本號由項(xiàng)目決定是否修改。* 階段版本號：一般是Bug修復(fù)或是一些小的變動，要經(jīng)常發(fā)布修訂版，時(shí)間間隔 不限，修復(fù)一個(gè)嚴(yán)重的Bug即可發(fā)布一個(gè)修訂版。此版本號由項(xiàng)目經(jīng)理決定是否修改。* 日期版本號用于記錄修改項(xiàng)目的當(dāng)前日期，每天對項(xiàng)目的修改都需要更改日期版本 號。此版本號由開發(fā)人員決定是否修改。* Alpha版：此版本表示該軟件在此階段主要是以實(shí)現(xiàn)軟件功能為主，通常只在軟件 開發(fā)者內(nèi)部交流，一般而言，該版本軟件的Bug較多，需要繼續(xù)修改。* Beta版：該版本相對于o版已有了很大的改進(jìn)，消除了嚴(yán)重的錯(cuò)誤，但還是存在 著一些缺陷，需要經(jīng)過多次測

6、試來進(jìn)一步消除，此版本主要的修改對像是軟件的UI。* RC版：該版本已經(jīng)相當(dāng)成熟了，基本上不存在導(dǎo)致錯(cuò)誤的BUG,與即將發(fā)行的正式 版相差無幾。* Release版：該版本意味“最終版本”，在前面版本的一系列測試版之后，終歸會 有一個(gè)正式版本，是最終交付用戶使用的一個(gè)版本。該版本有時(shí)也稱為標(biāo)準(zhǔn)版。一般情況 下，Release不會以單詞形式出現(xiàn)在軟件封面上，取而代之的是符號(R)。2. 3版本升級3. 3.1版本升級原則版本升級應(yīng)嚴(yán)格納入版本管理的控制之下。應(yīng)當(dāng)謹(jǐn)慎地控制版本的升級，保障高版本 的向下兼容性，或提供嚴(yán)格定義的升級方法。在下面幾種情況下，進(jìn)行版本演化和升級：1、當(dāng)產(chǎn)品發(fā)生重大修改和

7、改進(jìn)時(shí)，主版本號加1。重大修改和改進(jìn)包括：1）平臺遷移；2）開發(fā)工具的遷移；3）體系結(jié)構(gòu)的變遷。2、當(dāng)產(chǎn)品發(fā)生較小的改進(jìn)或修改時(shí)，次版本號可以加lo3、對于改動量比較少的，如修改產(chǎn)品的錯(cuò)誤，可升級修訂版本號。4、記錄版本升級過程。每次版本升級，都要填寫版本升級記錄表，記錄表樣例如 下：版本升級記錄表主版 本子系統(tǒng)名 稱子系統(tǒng)版 本發(fā)布日 期功能變更描述發(fā)布責(zé)任人批準(zhǔn) 人備注說明：版本號：記錄當(dāng)前發(fā)布的版本。發(fā)布日期：該版本批準(zhǔn)發(fā)布的日期。修改文件：版本修改記錄文件，一般為版本修改日志。2. 3. 2 新版本的發(fā)布新版本的發(fā)布包括主版本號和次版本號的升級，一般不包括內(nèi)部版本號的升級。流程 如下：

8、1、根據(jù)項(xiàng)目進(jìn)展情況，或者根據(jù)用戶需要進(jìn)行發(fā)布準(zhǔn)備。2、將發(fā)布所需文件進(jìn)行打包，放在指定目錄中，給目錄加上標(biāo)簽Tag,標(biāo)簽中包 含將要發(fā)布的版本信息。3、同樣對源碼文件也要加上與版本信息相關(guān)的標(biāo)簽Tag。標(biāo)簽Tag命名規(guī)則如下：組成：模塊首字母+下劃線+文件類型+下劃線+主版本號+次版本號+內(nèi)部版本號+時(shí)間 （+下劃線+合并標(biāo)記）樣例：qzcj_src_l_0_010923, qzcj表示采集模塊的首字母，src表示源碼，1_0_0表示將要發(fā)布的版本號，合并標(biāo)記可省略，只在有合并操作時(shí)注明，其中合并 前的標(biāo)記為mbe,合并后的標(biāo)記為mafo2.4目錄結(jié)構(gòu)但為了能更好地管理各項(xiàng)目組的文檔，建議可

9、將被管理的配置項(xiàng)分為三大類：文檔 類、源碼類及安裝盤類，這樣存放比較清晰，有利于版本管理，現(xiàn)將目錄結(jié)構(gòu)整理如下:根目錄目級錄 一二級目錄對應(yīng)配置項(xiàng)備注resp源碼code前置采集源碼后臺計(jì)算源碼業(yè)務(wù)應(yīng)用源碼數(shù)據(jù)庫SQL文件業(yè)務(wù)支撐公用開發(fā)包文檔 doc需求文檔立項(xiàng)報(bào)告、需求分析、 需求記錄設(shè)計(jì)文檔軟件架構(gòu)、總體設(shè)計(jì)、 概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)、 界面設(shè)計(jì)數(shù)據(jù)庫文檔數(shù)據(jù)字典、數(shù)據(jù)庫搭 建、備份還原方案、 PDM設(shè)計(jì)測試文檔測試計(jì)劃、測試用例、 測試報(bào)告用戶文檔用戶手冊、產(chǎn)品說明計(jì)劃文檔項(xiàng)目計(jì)劃、年度月度計(jì) 劃外部接口文 檔標(biāo)準(zhǔn)規(guī)范發(fā)布文 件SETUPreleaserar文件發(fā)布文檔二級目錄中的版本指一

10、些特殊的版本，不影響基線版本。2. 5文檔的存放2. 5.1文本文件的存放根據(jù)各項(xiàng)目部自己的情況，將系統(tǒng)用戶需求記錄、總體設(shè)計(jì)文檔、詳細(xì)設(shè)計(jì)及數(shù)據(jù)結(jié) 構(gòu)文件、測試記錄、用戶手冊等放入CVS倉庫doc目錄相應(yīng)的子目錄下。2. 5.2源代碼的存放源代碼包括如：java, jsp, BMP, ICO等相關(guān)文件，是未經(jīng)編譯處理的、不能直接交 付使用的產(chǎn)品文件以及編譯產(chǎn)品所需的文件；聯(lián)機(jī)幫助文件HLP在未生成HLP文件之前的 DOC, RTF等格式的文檔也視為源代碼。各子系統(tǒng)當(dāng)前的程序源文件放入CVS倉庫code目錄相應(yīng)的bb目錄下，對于一個(gè)子系 統(tǒng)乂分多個(gè)分子系統(tǒng)的情況，應(yīng)在該目錄下分別建立幾個(gè)相應(yīng)的

11、子目錄。2. 5.3發(fā)行文檔的存放發(fā)行文檔是指產(chǎn)品交付用戶使用所必須的文件。包括：產(chǎn)品可執(zhí)行文件，用戶使用說 明書，聯(lián)機(jī)幫助（HLP）；資源文件（BMP, ICO等），環(huán)境配置文件等。以上文檔作為制作發(fā)行盤的素材，放在CVS倉庫發(fā)布文件目錄的Release目錄之下， 制作好的發(fā)行盤放在發(fā)布文件的Setup目錄。2. 6權(quán)限控制管理為保障文檔的安全性，一致性，以及防止意外修改，必須對不同的文檔設(shè)置不同的訪 問權(quán)限。文檔權(quán)限類別：無任何權(quán)限，只讀權(quán)限，所有權(quán)限。文檔類別：設(shè)計(jì)文檔，源碼，發(fā)行文檔。用戶類別：開發(fā)人員、測試人員、項(xiàng)目經(jīng)理、配置管理員等。為了控制不同的使用權(quán)限，根據(jù)要求在服務(wù)器上分別建

12、立不同的用戶，針對不同的配 置項(xiàng)所在目錄分配不同的權(quán)限。為了便于管理，應(yīng)以表格的形式列出人員與管理對象的訪問關(guān)系（用戶權(quán)限清單）， 詳見系統(tǒng)部CVS權(quán)限配置。3備份管理為了保證文檔的最大可恢復(fù)性，要隨時(shí)及定期地進(jìn)行備份作。3. 1源文件備份開發(fā)人員每天都要將自己當(dāng)日修改的源文件提交（commit）至CVS倉庫。4. 2庫文件備份為防止服務(wù)器出現(xiàn)異常，需對服務(wù)器上的CVS倉庫文件進(jìn)行備份，目前采用的方案如 下：工作日備份：每個(gè)工作日將原本位于D盤的倉庫文件在H盤上備份一份，當(dāng)D盤倉庫 出現(xiàn)異常時(shí)，用戶可把ROOT目錄修改至H盤備份的目錄，再進(jìn)行更新操作。每月備份：每個(gè)月底將最新版本備份至光盤。4

13、用戶版本管理為了更好地管理源程序，應(yīng)為每一用戶建立一個(gè)用戶版本文件，該文件應(yīng)包含以下內(nèi) 容：用戶編號：用戶名稱：軟件版本號：開始使用時(shí)間：聯(lián)系人：聯(lián)系電話：用戶程序更改日志樣例如下：更改 時(shí)間版本號修改模 塊名稱變更原因變更概述軟件位置變更 人員備注說明:1）用戶購買軟件時(shí)要為該用戶建立一個(gè)包含上述內(nèi)容的一個(gè)用戶版本文件，并填寫 有關(guān)數(shù)據(jù)。2）用戶進(jìn)行版本更新時(shí)要求填寫該文件的版本變更記錄，用以反映用戶版本的變更 情況。5版本工具的使用5. 1配置管理工具開發(fā)部采用CVS進(jìn)行配置管理，CVS是一個(gè)C/S系統(tǒng)，多個(gè)開發(fā)人員通過一個(gè)中心版 本控制系統(tǒng)來記錄，從而達(dá)到保證文件同步的目的。目前采用的C

14、VS服務(wù)端為，客戶端為。5. 2 CVS的使用5. 2.1 常用命令英文命令中文命令操作、說明備注Checkout提取/取 出將文件下載到本地目錄第一次下載目錄 用Commit提交將改動過的文件提交到版本庫每次對文件更新 后使用Update更新將文件同步到最新版本獲取最新版本Tag標(biāo)簽給某個(gè)版本添加一個(gè)標(biāo)記符號便于合并分支與 主線Branch分支創(chuàng)建某個(gè)文件的分支建立特殊版本時(shí) 用到Merge合并將分支文件（或主文件）的更改合 并到主文件（或分支文件）diff比較不同比較任意兩個(gè)版本間的不同Reversion Graph版本分支 圖查看文件各版本（包括分支文件） 的走向圖查詢各個(gè)版本及 Tag

15、History歷史查看文件各個(gè)版本更新歷史查詢版本詳細(xì)信 息5. 2. 2 簡單操作文件提取：初次使用需將源文件從倉庫提取出來，執(zhí)行checkout命令將 庫文件提取至本地相應(yīng)位置。定時(shí)更新：開發(fā)人員每天早上對源代碼或文件進(jìn)行更新操作（右鍵執(zhí)行 update 操作）o實(shí)時(shí)更新：某一開發(fā)人員提交更改后，可通知其它人員進(jìn)行更新操作。實(shí)時(shí)提交：對某一文件進(jìn)行更改完成后，執(zhí)行commit命令將更改提交至 倉庫，更改前先進(jìn)行更新操作，如多個(gè)人員對同一文件同時(shí)進(jìn)行操作，會產(chǎn) 生沖突，這時(shí)需要對沖突進(jìn)行處理。沖突處理：提交產(chǎn)生沖突時(shí)，先對文件進(jìn)行同步（即更新）操作，之后會 產(chǎn)生一個(gè)合并文件，號前為兩個(gè)版本相

16、同部分，=號前為本地版本 修改的內(nèi)容，前為當(dāng)前服務(wù)器最新版本修改的內(nèi)容，找到最近提交該文 件的同事，進(jìn)行協(xié)商后對源文件進(jìn)行修改并提交。創(chuàng)建分支/標(biāo)簽：右鍵菜單中選擇Branch或Tag找開創(chuàng)建對話框,輸入 Branch 名或 Tag 名，選中，Create new branch / Create newtag,點(diǎn)擊OK即可。查看版本/歷史：文件（非文件夾）右健菜單中選擇RevisionGraph.或History.,可查看該文件的版本更新記錄或歷史信息。5. 2. 3版本分支管理我們把一個(gè)項(xiàng)目的主要開發(fā)過程稱作開發(fā)基線。當(dāng)某一個(gè)特殊事件發(fā)生的時(shí)候，例 如，有一個(gè)用戶有特殊的需求，于是就從這個(gè)開

17、發(fā)基線里分離出來一個(gè)又，以滿足用戶特 殊的需求，這個(gè)義有它自己的發(fā)展方向，這就是分支。分支開發(fā)基線上面這個(gè)點(diǎn)，代表開發(fā)基線的最新版本，如果從開發(fā)基線建立分支來進(jìn)行定制開發(fā)， 開發(fā)基線和分支就可以有各自的發(fā)展方向。如果有需要，分支的代碼可以重新合并到開發(fā) 基線中，開發(fā)基線的代碼也可以合并到分支代碼中。假設(shè)在我們的home目錄下的proj日錄就是我們的工程。下面具體看一下，如何建立 分支：1、當(dāng)我們要在基線某個(gè)版本建立分支時(shí)，先在基線該版本上創(chuàng)建一個(gè)標(biāo)簽（Tag）, 就是上圖中的黑點(diǎn)。這樣做是便于以后主干可以重新回到分支創(chuàng)建時(shí)的狀態(tài)。2、創(chuàng)建分支：右健單擊該目錄，選擇Branch,指定分支名，點(diǎn)擊0K即可。新建分支的版本號呈偶數(shù)序列遞增，如在基線3、在另外的目錄下執(zhí)行checkout命令，把剛才建立的分支提取出來（注意不要在原 來目錄下提取，那樣會覆蓋原有