Dokumen ini berisi petunjuk tentang cara membuat catatan rilis untuk Android Studio.
Objektif
Untuk membuat catatan rilis mendetail untuk commit dari repositori GitHub.
Petunjuk
Ikuti petunjuk ini secara berurutan dan sepenuhnya.
Langkah 1: Buat clone atau update repo
Periksa folder studio-main di project ini. Jika tidak ada, clone repositori studio-main menggunakan perintah berikut:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
Jika direktori sudah ada, muat ulang direktori dengan menarik konten repo dari GitHub.
Beri tahu saya status studio-main sebelum melanjutkan.
Langkah 2: Pelajari repo
Pelajari isi repo.
Langkah 3: Dapatkan commit
Dapatkan semua commit yang dikirimkan ke repositori studio-main selama jangka waktu yang saya berikan kepada Anda. Beri tahu saya jumlahnya sebelum melanjutkan. Selalu gunakan wc -l untuk menghitung.
Identifikasi commit target: Dari log git, ekstrak blok commit lengkap untuk setiap commit yang berisi string persis "Relnote:
" dengan adalah nama produk yang saya berikan. Jika saya tidak memberikan nama produk, cukup telusuri "Relnote". "Blok commit" mencakup hash commit, penulis, tanggal, pesan commit lengkap, dan perbedaan kode.
Gunakan alat yang tepat: Untuk memfilter commit menurut rentang tanggal dan nama produk, gunakan perintah berikut:
git log --after="
" --before=" " --grep="Relnote: " dengan
dan adalah rentang tanggal yang saya berikan kepada Anda, dan adalah nama produk yang saya berikan kepada Anda. Jika nama produk tidak diberikan, cukup gunakan perintah berikut:
git log --after="
" --before=" " --grep="Relnote" Konfirmasi jumlahnya: Tunjukkan jumlah total, hash, dan judul semua commit yang Anda identifikasi. Saya akan memberi Anda konfirmasi untuk melanjutkan.
Langkah 4: Buat catatan rilis mendetail
Analisis setiap commit: Untuk setiap commit yang Anda identifikasi pada langkah sebelumnya, lakukan analisis mendetail, yang mencakup:
- Membaca pesan commit lengkap.
- Memeriksa perbedaan kode (git show
) untuk memahami perubahan. - Mengikuti bug tertaut (misalnya, Bug: 12345678) untuk mengumpulkan konteks lebih lanjut.
Konfirmasi dengan saya sebelum melanjutkan.
Analisis dokumen terkait di folder docs untuk mendapatkan informasi terkait commit. Gunakan informasi ini untuk membuat catatan rilis yang kaya konten.
Beri tahu saya commit mana yang memiliki informasi terkait di folder docs sebelum melanjutkan.
Mendapatkan bug apa pun yang dirujuk dalam commit. Gunakan informasi dalam bug untuk membantu membuat catatan rilis untuk commit.
Tulis catatan rilis: Untuk setiap commit, tulis catatan rilis yang mencakup:
Referensi commit: Awali setiap catatan rilis dengan komentar Markdown yang berisi hash commit sumber, seperti ini: .
Judul yang jelas: Ringkasan perubahan yang ringkas dalam huruf kapital di awal setiap kata.
Penjelasan mendetail: Paragraf yang menjelaskan maksud perubahan.
Poin-poin penting tentang perubahan dalam urutan berikut:
a. Alasan: Apa yang berubah dan alasan perubahannya b. Dampak: Dampak pada developer aplikasi c. Migrasi: Jalur migrasi (jika ada)
Contoh kode "sebelum" dan "sesudah": Jika commit melibatkan perubahan kode yang terlihat oleh pengguna (misalnya, perubahan DSL dalam file .gradle atau modifikasi API), berikan cuplikan kode yang jelas dan ringkas yang menunjukkan perubahan tersebut.
Ikuti gaya catatan rilis di https://developer.android.com/studio/releases.
Langkah 5: Tulis catatan rilis ke file Markdown
- Buat file Markdown bernama release-notes-YYYY-MM-DDTHH:MM.md di root project, dengan--dalam format ISO 8601--YYYY-MM-DD (tahun-bulan-hari) adalah tanggal saat ini, T adalah pemisah, dan HH:MM (jam:menit dalam waktu jam 24 jam) adalah waktu saat ini.
- Tulis pengantar yang menjelaskan tujuan catatan rilis.
- Tulis ringkasan catatan rilis.
- Tulis catatan rilis lengkap yang diformat.
Langkah 6: Buat commit
Buat commit Fig untuk file catatan rilis. Jangan sertakan ID bug.
Langkah 7: Buat daftar perubahan
Buat CL commit.