Kami membuat salah satu alat di halaman ini. Kami berusaha mendeskripsikan yang lain berdasarkan tujuan pembuatannya alih-alih di mana mereka kurang, dan bagian tentang produk kami sendiri secara jelas mengatakan siapa yang seharusnya tidak memakainya.
Tiga kategorinya
Widget dan halaman hosting
Kamu menulis entri di editor mereka, mereka menghosting halamannya dan memberimu widget dalam aplikasi. Paling cepat diluncurkan, dan entrinya hidup di infrastruktur mereka bukan milikmu. Beamer dan AnnounceKit adalah contoh paling jelas.
Paket umpan balik dengan changelog terpasang
Changelog-nya adalah satu modul di samping voting fitur, roadmap publik, dan kotak masuk umpan balik. Layak jika kamu ingin seluruh lingkaran dari satu vendor, terlalu besar jika kamu hanya ingin mempublikasikan catatan rilis. Canny, Frill, dan Featurebase ada di sini.
Dihasilkan dari repositorimu
Changelog-nya diproduksi dari commit, pull request, atau issue alih-alih diketik tangan. Berkisar dari file yang dibangun di CI hingga entri yang disusun, ditinjau, dipublikasikan. git-cliff dan github-changelog-generator ada di ujung file; LaunchNotes, Released, dan produk kami sendiri ada di ujung publikasi.
Sekilas
| Alat | Jenis | Terbaik untuk |
|---|---|---|
| Beamer | Widget hosting | Memasang panel info terbaru di dalam aplikasi sore ini juga, tanpa memakai waktu tim engineering. |
| AnnounceKit | Widget hosting | Sama, dengan perhatian lebih pada segmentasi siapa melihat pengumuman yang mana. |
| Canny | Paket umpan balik | Tim yang menginginkan voting fitur dan roadmap publik, dengan changelog sebagai langkah penutup lingkaran itu. |
| Frill | Paket umpan balik | Tim yang lebih kecil yang ingin bentuk yang sama seperti Canny, tapi lebih ringan. |
| LaunchNotes | Dihasilkan dari repositori | Organisasi besar yang mengoordinasikan pengumuman lintas tim, sering kali berpusat pada Jira. |
| Released | Dihasilkan dari repositori | Tim yang sehari-hari bekerja di Jira dan ingin changelog dihasilkan dari issue tanpa keluar dari sana. |
| git-cliff | Generator file CI | Proyek open-source yang ingin CHANGELOG.md dibangun dari conventional commit di CI, tanpa hosting apa pun. |
| Changeloop | Dihasilkan dari repositori | Tim yang ingin entrinya disusun dari pull request yang digabungkan, lalu dirender oleh front end mereka sendiri dari feed JSON. |
Cara memilih
- Mulailah dari di mana changelog harus tampil. Jika harus terlihat seperti bagian dari produkmu, halaman hosting yang kamu tautkan akan mengecewakan tidak peduli sebagus apa editornya, dan kamu ingin widget yang bisa kamu gaya ulang atau feed yang kamu render. Jika halaman tertaut sudah cukup, alat hosting jauh lebih sedikit pekerjaannya.
- Lalu tanyakan siapa yang menulis entrinya. Jika jawabannya "engineer yang melakukan merge", pilih sesuatu yang membaca repositorimu, karena apa pun lainnya menambahkan langkah manual tepat pada saat semua orang sibuk. Jika jawabannya seorang pemasar produk yang bekerja dari rencana rilis, editor lebih cocok dan otomasi repositori hanya akan menghalangi.
- Lalu tanyakan apakah kamu butuh sisa lingkarannya. Voting fitur dan roadmap publik benar-benar berguna dan benar-benar komitmen yang lebih besar. Membeli paket untuk modul changelog-nya adalah cara tim berakhir membayar empat hal untuk memakai satu.
- Terakhir, periksa apa yang terjadi pada entrimu jika kamu pergi. Alat yang akan mengekspornya sebagai data terstruktur berbeda jauh dari yang entrinya hidup di halaman hosting yang harus kamu scrape.
Di mana alat kami sendiri cocok, dan di mana tidak
Changeloop membaca setiap pull request yang digabungkan, menyusun entri yang ditujukan untuk pengguna, menyaring pembaruan dependensi dan refactor, dan menahan draf untuk peninjauan. Yang dipublikasikan pergi ke feed JSON publik dengan feed roadmap di sampingnya, ditambah widget dua baris dan halaman hosting sebagai cadangan. Feed-nya adalah intinya: pengaturan yang dimaksudkan adalah kamu merender changelog-mu di dalam produkmu sendiri dengan komponenmu sendiri.
Jangan pilih jika:
- Rilismu tidak berasal dari repositorimu. Drafnya disusun dari merge atau, dalam mode push, dari push, jadi tim yang mengirim di luar alur kerja Git tidak punya apa pun untuk ditinjau.
- Kamu ingin voting fitur dan roadmap yang divoting penggunamu. Ada feed roadmap, tapi digerakkan oleh issue berlabel, bukan voting pengguna. Paket umpan balik adalah kategori yang tepat untuk itu.
- Kamu ingin editor yang rapi dan halaman hosting sebagai produk utama. Halaman hosting ada sebagai cadangan, dan alat yang dibangun di sekitar halaman mereka akan melakukannya lebih baik.
- Kamu adalah proyek open-source solo yang hanya ingin CHANGELOG.md di repositori. Pakai git-cliff, yang gratis dan dibuat persis untuk itu.
Pertanyaan umum
Apakah kita benar-benar butuh sebuah alat?
Untuk sementara, tidak. File markdown, atau halaman di situsmu sendiri, adalah changelog yang cukup baik dan tidak berbiaya apa pun. Titik saat sebuah alat mulai sepadan adalah saat menulis entrinya menjadi langkah yang sering dilewati, atau saat kamu ingin entri yang sama di tiga tempat tanpa memelihara tiga salinan.
Bisakah kita pindah dari salah satunya nanti?
Sepenuhnya tergantung apakah entrinya bisa keluar lagi sebagai data terstruktur. Tanyakan sebelum mulai, bukan sesudahnya: ini satu-satunya pertanyaan dalam daftar yang mahal jika salah, karena changelog adalah arsip yang terus tumbuh dan mengetik ulang dua tahun isinya bukan proyek yang akan disetujui siapa pun.
Bagaimana dengan menulisnya dengan asisten AI?
Sebagian besar alat ini sekarang menyusun dengan model di suatu tempat. Yang lebih penting adalah apa yang diberikan ke modelnya. Alat yang hanya melihat subjek commit hanya bisa menulis ulang subjek itu; yang melihat judul dan deskripsi pull request punya cukup untuk mendeskripsikan perubahan dalam istilah apa yang dilakukannya bagi pengguna. Tanyakan apa inputnya, bukan apakah ada AI-nya.
Bacaan lebih lanjut: otomasi changelog, dan batasannya, tentang keempat langkah mana yang seharusnya otomatis.
Yang mengutamakan feed
Disusun dari pull request-mu yang digabungkan, ditahan untuk peninjauan, dipublikasikan ke feed JSON yang kamu render sendiri. Gratis untuk satu repositori, tanpa kartu.
Mulai gratis