Pembuat Templat CHANGELOG.md
Hasilkan templat CHANGELOG.md yang sesuai dengan Keep-a-Changelog dengan grup versi semantik, log yang belum dirilis, dan referensi perbandingan tag Git otomatis.
Fill in your project name, repository link, and release version logs to export a Keep-a-Changelog standard markdown document.
Display name of your application.
A brief, one-sentence tagline.
Required to generate Git tag comparison links.
Determines formatting structure and links.
Release Version History & Logs
Mengapa Menggunakan Pembuat Templat CHANGELOG.md Kami?
- Standar Keep-a-Changelog: Pastikan kepatuhan yang ketat terhadap spesifikasi. Alat kami menghasilkan log perubahan standar v1.1.0 yang berisi kategori semantik standar yang diurutkan dengan benar.
- Tautan Perbandingan Otomatis: Meningkatkan kredibilitas repositori. Berikan URL Repositori GitHub Anda untuk secara otomatis mengkompilasi URL referensi perbandingan antara semua tag di bagian bawah.
- Berbagai Format Output: Dapatkan format yang sesuai dengan alur kerja Anda. Ekspor sebagai Penurunan Harga Keep-a-Changelog, Poin-poin Changelog Umum, atau penurunan harga Catatan Rilis GitHub yang bersih.
- 100% Privasi Sisi Klien: Jaga keamanan detail proyek Anda. Generator menangani semua parameter formulir, log rilis, dan rendering template secara lokal di dalam browser web Anda.
Apa yang dimaksud dengan Standar Keep-a-Changelog?
Keep a Changelog adalah spesifikasi komunitas yang diadopsi secara luas yang menetapkan struktur seragam dan dapat dibaca manusia untuk log modifikasi proyek. Alih-alih memasukkan semua pembaruan ke dalam satu daftar poin besar, standar ini secara ketat mendefinisikan enam grup semantik: **Ditambahkan, Diubah, Tidak Digunakan Lagi, Dihapus, Diperbaiki, dan Keamanan**. Pengelompokan yang dikategorikan ini memudahkan pengembang, pengelola, dan pengguna akhir untuk memindai catatan versi Anda dan dengan cepat menemukan penambahan fitur penting, peringatan penghentian, atau pembaruan keamanan.
Mengapa Git Commit Logs Bukan Pengganti Changelogs
Banyak pengembang yang secara keliru membuang log Git mentah mereka langsung ke dalam file teks dan menyebutnya sebagai changelog. Namun, git log dirancang untuk **mesin dan kompiler**, diisi dengan komitmen mikro, koreksi kesalahan ketik, log cabang gabungan, dan catatan yang berpusat pada kode. Changelog profesional dirancang untuk **orang**. Ini mengatur komitmen tersebut, memfilter pembaruan yang tidak penting, dan menerjemahkan perubahan mentah menjadi deskripsi yang jelas dan dapat dilihat pengguna. Log tulisan tangan memastikan bahwa pengembang dapat membaca dan memahami apa yang baru dan bagaimana dampaknya terhadap integrasi mereka.
Prinsip Inti Pembuatan Versi Semantik (SemVer)
Mengikuti Versi Semantik mewakili landasan ekosistem perangkat lunak yang stabil. Nomor versi SemVer disusun sebagai Major.Minor.Patch (misalnya 1.2.3). Versi **PATCH** bertambah ketika Anda merilis perbaikan bug yang kompatibel dengan versi sebelumnya. Versi **MINOR** bertambah saat Anda menambahkan fitur baru yang kompatibel dengan versi sebelumnya. Versi **MAJOR** dicadangkan untuk menghentikan modifikasi API yang mengharuskan pengguna memperbarui integrasinya. Melacak versi ini di dalam log perubahan terstruktur menjaga dependensi Anda tetap aman dan transparan.
Kekuatan Tautan Perbandingan Git Otomatis
Changelog yang benar-benar profesional tidak hanya mencantumkan versi-tetapi juga menghubungkannya. Dengan menyertakan referensi link perbandingan di bagian bawah file Anda, pengguna dapat mengklik nomor versi mana pun untuk melihat perbedaan kode persis di GitHub antara rilis saat ini dan tag sebelumnya. Generator ini secara otomatis mengkompilasi tautan referensi perbandingan ini berdasarkan URL repositori Anda. Ini memetakan rilis berikutnya ke direktori perbandingan perbandingan GitHub dan menandai rilis awal dengan benar, sehingga meningkatkan kepercayaan dan transparansi pengembang.
Pertanyaan yang Sering Diajukan
Generator Templat CHANGELOG.md adalah alat online gratis yang secara otomatis membuat file CHANGELOG.md yang siap produksi dan sesuai dengan Keep-a-Changelog. Ini mendukung item rilis khusus, bagian yang belum dirilis, dan tautan perbandingan Git otomatis.
Spesifikasi tersebut mendefinisikan enam kategori untuk mengelompokkan semua modifikasi kode: Ditambahkan (fitur baru), Berubah (perubahan pada fitur yang sudah ada), Tidak digunakan lagi (fitur yang akan segera dihapus), Dihapus (fitur dihapus), Diperbaiki (perbaikan bug), dan Keamanan (tambalan dan peningkatan keamanan).
Dengan memberikan URL repositori GitHub Anda, generator secara otomatis mengkompilasi referensi perbandingan penurunan harga di bagian bawah file. Mengklik header versi rilis akan membawa pengguna langsung ke tampilan perbandingan perbedaan GitHub yang menunjukkan perubahan antara tag rilis saat ini dan tag sebelumnya.
Log komit Git bersifat teknis, bertele-tele, dan ditujukan untuk mesin. Changelog tulisan tangan dikurasi khusus untuk pembaca manusia. Ini menyaring komitmen yang sepele, mengelompokkan perubahan ke dalam kategori semantik yang bersih, dan menjelaskan manfaat atau dampak sebenarnya dari perubahan tersebut.
Alat ini menyediakan format penurunan harga khusus Rilis GitHub yang menghapus metadata header dan tautan referensi. Ini memberikan daftar poin yang bersih dan dapat disalin-tempel yang dikelompokkan berdasarkan emoji, cocok untuk ditempelkan langsung ke dasbor rilis GitHub/GitLab.
Ya! Anda dapat menentukan tag Versi Semantik standar apa pun, termasuk tag pra-rilis seperti 1.0.0-beta.1 atau 1.0.0-rc.2. Sistem validasi akan memprosesnya dengan benar sesuai spesifikasi SemVer 2.0.0.
Ya, 100%. Semua pemrosesan dan kompilasi template terjadi secara lokal di browser web Anda menggunakan JavaScript sisi klien. Tidak ada variabel lingkungan, pengaturan port, kunci rahasia, atau cuplikan kode yang pernah dikirim atau diunggah ke server mana pun, sehingga menjamin privasi penuh.