Generator changelog

Belum ada apa-apa. Tempel beberapa baris di atas dan tekan Buat.

Apa yang dilakukannya pada setiap baris

Aturannya sengaja dibuat sederhana dan terlihat, jadi kamu bisa memprediksi outputnya alih-alih menebak-nebak:

1. Conventional commit dikelompokkan berdasarkan jenis. `feat` menjadi Baru, `fix` menjadi Diperbaiki, `perf` menjadi Ditingkatkan. Sebuah `!` sebelum titik dua, atau penanda BREAKING CHANGE, memindahkan baris itu ke Perubahan yang merusak kompatibilitas terlepas dari jenisnya.
2. Apa pun yang bukan conventional commit diurutkan berdasarkan kata pertamanya. Add, Added, Introduce, dan Support menjadi Baru; Fix, Fixed, dan Resolve menjadi Diperbaiki; Improve, Update, Speed, dan Optimise menjadi Ditingkatkan; Remove, Removed, Drop, dan Deprecate menjadi Dihapus. Sisanya masuk ke Lainnya untuk kamu urutkan sendiri.
3. Kebisingan dihilangkan: nomor pull request di akhir, baris `Merge pull request ...`, scope dalam tanda kurung, dan prefiks jenis conventional commit itu sendiri. Kalimat yang tersisa diberi huruf besar di awal.
4. Dengan filter menyala, baris `chore`, `ci`, `test`, `build`, `style`, dan `refactor` dibuang, bersama apa pun yang terlihat seperti pembaruan dependensi. Ini adalah perbedaan tunggal terbesar antara changelog yang dibaca orang dan yang berhenti mereka baca.

Apa yang tidak bisa dilakukannya

Ini menulis ulang bentuk pesan commit-mu, bukan isinya. Jika sebuah commit berkata `fix: race in MembershipCache.resolve()`, itulah yang keluar, dan itu masih kalimat tentang kodemu alih-alih pengalaman pengguna. Mengubah "race in MembershipCache" menjadi "anggota yang diundang tidak lagi melihat dasbor kosong" memerlukan pengetahuan tentang apa yang dilakukan perubahan itu, yang merupakan bagian yang tidak bisa disimpulkan generator dari baris subjek commit.

Jadi perlakukan outputnya sebagai lintasan pertama: struktur benar, pengelompokan benar, kebisingan internal sudah hilang, kata-kata masih perlu kamu perbaiki.

Pertanyaan umum

Apakah yang aku tempel diunggah ke suatu tempat?

Tidak. Generator ini adalah skrip di halaman ini; teksnya tidak pernah keluar dari browsermu dan tidak ada permintaan ke kami saat kamu menekan Buat. Kamu bisa memastikan itu dengan tab jaringan terbuka.

Haruskah aku pakai conventional commits?

Tidak. Baris yang mengikuti konvensi dikelompokkan lebih akurat, dan sisanya kembali ke kata kerja awal. Repositori dengan pesan commit berupa kalimat biasa tetap menghasilkan draf yang bisa dipakai.

Bagaimana cara mendapatkan ini secara otomatis dari repositoriku?

Untuk sekali pakai, `git log --pretty=format:%s v1.2.0..HEAD` memberi persis input yang diharapkan ini. Untuk yang berkelanjutan, git-cliff dan github-changelog-generator sama-sama membangun file changelog di CI dari riwayat commit-mu, dan Changeloop menyusun entri yang ditujukan untuk pengguna per pull request yang digabungkan dan menahannya untuk peninjauan.

Kenapa outputku penuh dengan Lainnya?

Kata kerja awalnya tidak cocok dengan apa pun yang dikenal, yang biasanya berarti subjek commit dimulai dengan kata benda atau ID tiket. Bisa edit di kotak sebelum membuat, atau pindahkan baris Lainnya secara manual setelahnya.

Bacaan lebih lanjut: dari conventional commits ke sebuah changelog, tentang apa yang didapatkan format commit dan di mana batasnya.