本文說明如何建立 Android Studio 的版本資訊。
目標
為 GitHub 存放區中的提交建立詳細版本資訊。
操作說明
請依序完整按照這些指示操作。
步驟 1:複製或更新存放區
檢查這個專案中是否有 studio-main 資料夾。如果沒有,請使用下列指令複製 studio-main 存放區:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
如果目錄已存在,請從 GitHub 提取存放區內容,重新整理目錄。
請先告知 studio-main 的狀態,再繼續操作。
步驟 2:研究存放區
研究存放區的內容。
步驟 3:取得提交內容
請取得我在這段時間內提交至 studio-main 存放區的所有提交內容。請先告知數量,再繼續操作。一律使用 wc -l 進行計數。
找出目標提交:從 Git 記錄中,為每個包含「Relnote:
」確切字串的提交項目,擷取完整提交區塊,其中 是我提供的產品名稱。如果我未提供產品名稱,請直接搜尋「Relnote」。 「提交區塊」包含提交雜湊、作者、日期、完整提交訊息和程式碼差異。
使用正確的工具:如要依日期範圍和產品名稱篩選提交內容,請使用下列指令:
git log --after="
" --before=" " --grep="Relnote: " 其中
和 是我提供的日期範圍, 則是我提供的產品名稱。 如果未提供產品名稱,請使用下列指令:
git log --after="
" --before=" " --grep="Relnote" 確認計數:顯示您識別的所有提交內容的總數、雜湊和標題。我會確認並繼續。
步驟 4:產生詳細版本資訊
分析每個提交:針對上一步驟中識別的每個提交,執行詳細分析,包括:
- 閱讀完整提交訊息。
- 檢查程式碼差異 (git show
),瞭解變更內容。 - 追蹤任何連結的錯誤 (例如「錯誤:12345678」),以收集更多背景資訊。
請先與我確認再繼續。
分析文件資料夾中的任何相關文件,找出與提交內容相關的資訊。您可以根據這項資訊,製作內容豐富的版本說明。
請先告訴我哪些提交內容在 docs 資料夾中含有相關資訊,再繼續操作。
取得提交內容中參照的任何錯誤。使用錯誤中的資訊,協助建立提交的發行說明。
撰寫版本資訊:為每個提交內容撰寫版本資訊,內容包括:
提交參考資料:在每則版本資訊前面加上 Markdown 註解,內含來源提交雜湊,例如:。
明確的標題:簡短的句子,以句首大寫的形式說明變更內容。
詳細說明:一段文字,說明變更內容。
變更重點如下:
a. 原因:變更內容和原因 b. 影響:對應用程式開發人員的影響 c. 遷移:遷移路徑 (如有)
「之前」和「之後」的程式碼範例:如果提交內容涉及使用者面向的程式碼變更 (例如 .gradle 檔案中的 DSL 變更或 API 修改),請提供清楚簡潔的程式碼片段,說明變更內容。
請按照 https://developer.android.com/studio/releases 的版本資訊樣式撰寫。
步驟 5:將版本說明寫入 Markdown 檔案
- 在專案根目錄中建立名為 release-notes-YYYY-MM-DDTHH:MM.md 的 Markdown 檔案, 其中 YYYY-MM-DD (年-月-日) 是目前日期,T 是分隔符號, 而 HH:MM (時:分,以 24 小時制表示) 則是目前時間,以上皆採用 ISO 8601 格式。
- 撰寫簡介,說明版本資訊的用途。
- 撰寫版本資訊摘要。
- 撰寫完整且格式正確的版本資訊。
步驟 6:建立提交
為版本資訊檔案建立 Fig 提交。請勿加入錯誤 ID。
步驟 7:建立變更清單
建立提交的 CL。