1. 程式人生 > >markdown寫的文件範例&版本釋出工具

markdown寫的文件範例&版本釋出工具

# 版本更新工具使用說明 V1.0.0
* 釋出新版本操作流程
	* 生成和釋出測試版
		1. 進入`clientversion `目錄
		2. 拉取版本庫內最新內容
		3. 進入更新平臺目錄`./IOS`或者`./Android`
		4. 根據目錄下的版本號建立最新版版本資料夾`version_dir_(版本號)/files`
		5. 將要更新的檔案(`res和src`)複製到最新版本資料夾中的`files`資料夾裡
		2. 執行`sh version.sh`或`java -jar version-builder-1.0.0.jar`
		3. 按照提示輸入平臺名稱`IOS`或`Android`(區分大小寫)
		4. 輸入是否為測試版(`true`表示新生成的版本,`false`表示將上一個生成為測試版的版本釋出為正式版,釋出正式版可能因為許可權不足而被拒絕)
		5. 釋出測試版本,輸入`true`
		6. 輸入是否為里程碑版本(當本次更新要求玩家必須安裝新版app時稱為里程碑版本,里程碑版本需要在之後的步驟中提供app檔案下載連結)
		7. 如果步驟6為`true`
			1. 按照提示輸入里程碑版本要釋出的所有渠道的`渠道號`,用`,`分隔
			2. 按照提示輸入每個渠道對應的下載連結(必須以協議開頭,即http開頭),DEFAULT表示預設渠道,當客戶端沒有發來渠道號或者發來一個未知渠道號時返回此連結
		8. 如果步驟6為`false`
			1. 工具會根據最近一個里程碑版本資源和之後一隻到當前版本的每個版本資源進行比對
		9. 接下來系統會列出它已經收集到的資訊,並且提示使用者確認以上資訊是準確無誤的,如果覺得沒有問題輸入`true`
		10. 至此,工具會根據目前已經收集到的資訊進行整理和對比,提示使用者確認相對於`基礎版本`和`上一個版本`的`改動檔案數`
		11. 如果使用者對改動個數確認無誤,工具將自動完成檔案打包、切割上傳,如果系統執行正確則會返回資訊`res`為`success`

	* 釋出正式版
		1. 進入`clientversion `目錄
		2. 執行`sh version.sh`或`java -jar version-builder-1.0.0.jar`
		3. 按照提示輸入平臺名稱`IOS`或`Android`(區分大小寫)
		4. 輸入是否為測試版(`true`表示新生成的版本,`false`表示將上一個生成為測試版的版本釋出為正式版,釋出正式版可能因為許可權不足而被拒絕)
		5. 釋出正式版本,輸入`false`
		6. 版本釋出流程至此結束,工具會將上次釋出為測試版的版本,開放為正式版,如果遇到錯誤將返回錯誤資訊


	* 注意事項
		* 為了減少分析歷史檔案所消耗的時間,系統生成版本後會在版本目錄中建立相關檔案記錄版本資訊,所以應滿足如下要求:
			2. 每次生成新版本前**必須拉取版本庫內最新內容**.
			1. 每次生成新版本過程中**必須目測確認系統要求確認的資料是正確無誤的**,如果存在問題或者有疑惑,需要尋求其他人幫助,確認無誤後才可以繼續執行.
			1. 除非瞭解工具工作原理,否則**任何時候不得隨意修改和標記廢棄已釋出的版本中的檔案和工具生成的檔案**.
			3. 每次系統正確上傳版本後**必須向git提交和推送**本次生成後的**全部新增和改動的檔案**,以確保下次生成版本使用.


* 版本釋出工具commit提交規範
	* 為了在提交描述中清晰的顯示更多內容,提交版本資訊統一使用`git commit`,注意不加引數`-m`
	
	* 釋出版本示例
	
			型別:資源更新 或 整包更新
			顯示版本號:V1.2.0
			資源版本號:90
			分支名稱:master
            操作者:XXX
			可選的其他說明:
		
	* 廢棄版本示例
	
			型別:廢棄
			資源版本號:90
			分支名稱:master
            操作者:XXX
			廢棄原因:資源不對