เอกสารนี้มีวิธีการเกี่ยวกับการสร้างบันทึกประจำรุ่นสำหรับ 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 log ให้ดึงบล็อกคอมมิตแบบเต็มสำหรับทุกคอมมิตที่มีสตริง "Relnote:
" ที่ตรงกันทุกประการ โดย คือชื่อผลิตภัณฑ์ที่ฉันระบุ หากฉันไม่ได้ระบุชื่อผลิตภัณฑ์ ให้ค้นหา "Relnote" "บล็อกการคอมมิต" ประกอบด้วยแฮชการคอมมิต ผู้เขียน วันที่ ข้อความคอมมิตแบบเต็ม และ diff ของโค้ด
ใช้เครื่องมือที่ถูกต้อง: หากต้องการกรองคอมมิตตามช่วงวันที่และชื่อผลิตภัณฑ์ ให้ใช้คำสั่งต่อไปนี้ command:
git log --after="
" --before=" " --grep="Relnote: " โดย
และ คือช่วงวันที่ที่เราให้คุณ และ คือ ชื่อผลิตภัณฑ์ที่เราให้คุณ หากไม่ได้ระบุชื่อผลิตภัณฑ์ ให้ใช้คำสั่งต่อไปนี้
git log --after="
" --before=" " --grep="Relnote" ยืนยันจำนวน: แสดงจำนวนทั้งหมด แฮช และชื่อของคอมมิตทั้งหมดที่คุณ ระบุ ฉันจะให้การยืนยันเพื่อดำเนินการต่อ
ขั้นตอนที่ 4: สร้างหมายเหตุประจำรุ่นแบบละเอียด
วิเคราะห์แต่ละคอมมิต: สำหรับแต่ละคอมมิตที่คุณระบุในขั้นตอนก่อนหน้า ให้ทำการวิเคราะห์โดยละเอียด ซึ่งรวมถึง
- การอ่านข้อความคอมมิตฉบับเต็ม
- ตรวจสอบความแตกต่างของโค้ด (git show
) เพื่อทำความเข้าใจการเปลี่ยนแปลง - ติดตามข้อบกพร่องที่ลิงก์ (เช่น ข้อบกพร่อง: 12345678) เพื่อรวบรวมบริบทเพิ่มเติม
โปรดยืนยันกับฉันก่อนดำเนินการต่อ
วิเคราะห์เอกสารที่เกี่ยวข้องในโฟลเดอร์เอกสารเพื่อดูข้อมูลที่เกี่ยวข้องกับการคอมมิต ใช้ข้อมูลนี้เพื่อสร้างหมายเหตุประจำรุ่นที่มีเนื้อหาครบถ้วน
โปรดแจ้งให้เราทราบว่าคอมมิตใดมีข้อมูลที่เกี่ยวข้องในโฟลเดอร์เอกสารก่อนดำเนินการต่อ
รับข้อบกพร่องที่อ้างอิงในการคอมมิต ใช้ข้อมูลในข้อบกพร่องเพื่อช่วยสร้าง หมายเหตุประจำรุ่นสำหรับการเปลี่ยนแปลง
เขียนบันทึกประจำรุ่น: สำหรับแต่ละคอมมิต ให้เขียนบันทึกประจำรุ่นที่มีข้อมูลต่อไปนี้
ข้อมูลอ้างอิงการคอมมิต: ใส่ความคิดเห็น Markdown ที่มีแฮชการคอมมิตของแหล่งที่มาไว้ก่อนบันทึกประจำรุ่นแต่ละรายการ เช่น
ชื่อที่ชัดเจน: สรุปการเปลี่ยนแปลงแบบ Sentence Case ที่กระชับ
คำอธิบายโดยละเอียด: ย่อหน้าอธิบายว่าการเปลี่ยนแปลงนี้เกี่ยวข้องกับอะไร
ประเด็นสำคัญเกี่ยวกับการเปลี่ยนแปลงตามลำดับต่อไปนี้
ก. เหตุผล: มีการเปลี่ยนแปลงอะไรและเหตุใดจึงมีการเปลี่ยนแปลง ข. ผลกระทบ: ผลกระทบต่อนักพัฒนาแอป ค. การย้ายข้อมูล: เส้นทางการย้ายข้อมูล (หากมี)
ตัวอย่างโค้ด "ก่อน" และ "หลัง": หากคอมมิตเกี่ยวข้องกับการเปลี่ยนแปลงโค้ดที่ผู้ใช้มองเห็น (เช่น การเปลี่ยนแปลง DSL ในไฟล์ .gradle หรือการแก้ไข API) ให้ระบุข้อมูลโค้ดที่ชัดเจนและกระชับซึ่งแสดงให้เห็นการเปลี่ยนแปลง
ทำตามรูปแบบบันทึกประจำรุ่นที่ https://developer.android.com/studio/releases
ขั้นตอนที่ 5: เขียนหมายเหตุประจำรุ่นลงในไฟล์ Markdown
- สร้างไฟล์ Markdown ชื่อ release-notes-YYYY-MM-DDTHH:MM.md ในรูทของโปรเจ็กต์ โดยที่ YYYY-MM-DD (ปี-เดือน-วัน) คือวันที่ปัจจุบัน T คือตัวคั่น และ HH:MM (ชั่วโมง:นาทีในเวลาแบบ 24 ชั่วโมง) คือเวลาปัจจุบัน ทั้งหมดอยู่ในรูปแบบ ISO 8601
- เขียนคำนำที่อธิบายวัตถุประสงค์ของบันทึกประจำรุ่น
- เขียนสรุปของบันทึกประจำรุ่น
- เขียนบันทึกประจำรุ่นที่จัดรูปแบบอย่างครบถ้วน
ขั้นตอนที่ 6: สร้างการคอมมิต
สร้างการคอมมิต Fig สำหรับไฟล์หมายเหตุประจำรุ่น อย่าใส่รหัสข้อบกพร่อง
ขั้นตอนที่ 7: สร้างรายการการเปลี่ยนแปลง
สร้าง CL ของคอมมิต