Tài liệu này chứa hướng dẫn về cách tạo ghi chú phát hành cho Android Studio.
Mục tiêu
Để tạo ghi chú phát hành chi tiết cho các cam kết từ một kho lưu trữ GitHub.
Hướng dẫn
Hãy làm theo các hướng dẫn này một cách tuần tự và đầy đủ.
Bước 1: Sao chép hoặc cập nhật kho lưu trữ
Kiểm tra xem có thư mục studio-main trong dự án này hay không. Nếu không có, hãy sao chép kho lưu trữ studio-main bằng lệnh sau:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
Nếu thư mục đã tồn tại, hãy làm mới thư mục bằng cách kéo nội dung của kho lưu trữ từ GitHub.
Hãy cho tôi biết trạng thái của studio-main trước khi tiếp tục.
Bước 2: Nghiên cứu kho lưu trữ
Nghiên cứu nội dung của kho lưu trữ.
Bước 3: Nhận các cam kết
Lấy tất cả các cam kết được gửi đến kho lưu trữ studio-main trong khoảng thời gian mà tôi đã cung cấp cho bạn. Hãy cho tôi biết số lượng trước khi tiếp tục. Luôn sử dụng wc -l để đếm.
Xác định các cam kết mục tiêu: Từ nhật ký git, hãy trích xuất toàn bộ khối cam kết cho mọi cam kết chứa chuỗi chính xác "Relnote:
" trong đó là tên sản phẩm mà tôi đã cung cấp. Nếu tôi không cung cấp tên sản phẩm, hãy tìm kiếm "Relnote". "Khối cam kết" bao gồm hàm băm cam kết, tác giả, ngày, toàn bộ thông báo cam kết và sự khác biệt về mã.
Sử dụng đúng công cụ: Để lọc các cam kết theo phạm vi ngày và tên sản phẩm, hãy sử dụng lệnh sau:
git log --after="
" --before=" " --grep="Relnote: " trong đó
và là phạm vi ngày mà tôi đã cung cấp cho bạn, còn là tên sản phẩm mà tôi đã cung cấp cho bạn. Nếu không có tên sản phẩm, hãy dùng lệnh sau:
git log --after="
" --before=" " --grep="Relnote" Xác nhận số lượng: Cho tôi biết tổng số, hàm băm và tiêu đề của tất cả các cam kết mà bạn đã xác định. Tôi sẽ xác nhận để bạn tiếp tục.
Bước 4: Tạo ghi chú phát hành chi tiết
Phân tích từng cam kết: Đối với mỗi cam kết mà bạn xác định được ở bước trước, hãy thực hiện phân tích chi tiết, bao gồm:
- Đọc toàn bộ thông báo cam kết.
- Kiểm tra sự khác biệt về mã (git show
) để hiểu rõ thay đổi. - Theo dõi mọi lỗi được liên kết (ví dụ: Lỗi: 12345678) để thu thập thêm thông tin.
Hãy xác nhận với tôi trước khi tiếp tục.
Phân tích mọi tài liệu liên quan trong thư mục tài liệu để biết thông tin liên quan đến các cam kết. Hãy dùng thông tin này để tạo một ghi chú phát hành giàu nội dung.
Hãy cho tôi biết những cam kết nào có thông tin liên quan trong thư mục tài liệu trước khi tiếp tục.
Lấy mọi lỗi được tham chiếu trong các cam kết. Sử dụng thông tin trong lỗi để giúp tạo ghi chú phát hành cho cam kết.
Viết ghi chú phát hành: Đối với mỗi cam kết, hãy viết một ghi chú phát hành bao gồm:
Thông tin tham chiếu về cam kết: Thêm một nhận xét Markdown chứa hàm băm cam kết nguồn vào trước mỗi ghi chú phát hành, chẳng hạn như: .
Tiêu đề rõ ràng: Nội dung tóm tắt ngắn gọn theo kiểu viết hoa chữ cái đầu của câu về nội dung thay đổi.
Nội dung giải thích chi tiết: Một đoạn văn giải thích về nội dung thay đổi.
Các điểm chính về thay đổi theo thứ tự sau:
a. Lý do: Nội dung thay đổi và lý do thay đổi b. Tác động: Tác động đối với nhà phát triển ứng dụng c. Di chuyển: Đường dẫn di chuyển (nếu có)
Ví dụ về mã "trước" và "sau": Nếu cam kết liên quan đến một thay đổi về mã mà người dùng nhìn thấy (ví dụ: các thay đổi về DSL trong tệp .gradle hoặc các sửa đổi về API), hãy cung cấp các đoạn mã rõ ràng, ngắn gọn minh hoạ thay đổi đó.
Tuân theo kiểu ghi chú phát hành tại https://developer.android.com/studio/releases.
Bước 5: Viết ghi chú phát hành vào một tệp Markdown
- Tạo một tệp Markdown có tên là release-notes-YYYY-MM-DDTHH:MM.md trong thư mục gốc của dự án, trong đó YYYY-MM-DD (năm-tháng-ngày) là ngày hiện tại theo định dạng ISO 8601, T là dấu phân cách và HH:MM (giờ:phút theo giờ 24) là giờ hiện tại.
- Viết một phần giới thiệu giải thích mục đích của ghi chú phát hành.
- Viết bản tóm tắt về ghi chú phát hành.
- Viết ghi chú phát hành đầy đủ và có định dạng.
Bước 6: Tạo một cam kết
Tạo một cam kết Fig cho tệp ghi chú phát hành. Không cung cấp mã lỗi.
Bước 7: Tạo danh sách thay đổi
Tạo một CL cho cam kết.