Aliran Kerja Profesional Git dan GitHub · Pelajaran

Menjana Changelog dan Nota Keluaran

Pelajari cara menghasilkan changelog dan nota keluaran automatik yang jelas daripada sejarah Git dan komit konvensional.

Pelajaran 4 daripada 413 langkah

Menjana Changelog dan Nota Keluaran ialah pelajaran Aliran Kerja Profesional Git dan GitHub percuma di CoddyKit. Ini ialah pelajaran 4 daripada 4. Anda boleh membaca keseluruhan pelajaran di bawah secara percuma — kemudian berlatih secara praktikal dalam pelayar menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7. Pelajaran ini merupakan sebahagian daripada laluan pembelajaran Aliran Kerja Profesional Git dan GitHub, dan kemajuan anda disegerakkan merentas web serta aplikasi CoddyKit. Kursus Aliran Kerja Profesional Git dan GitHub merangkumi sejumlah 4 pelajaran.

Apakah Log Perubahan?

Log perubahan ialah senarai perubahan penting bagi setiap versi yang disusun dan mudah dibaca manusia. Log ini disimpan dalam fail seperti CHANGELOG.md di akar repositori.

Mengapa Log Perubahan Penting

Pengguna dan ahli sepasukan membaca log perubahan untuk memahami:

Ciri baharu
Pembaikan pepijat
Perubahan yang memecahkan keserasian

Log perubahan menjadikan naik taraf lebih selamat dan pantas.

Format Keep a Changelog

Konvensyen yang biasa digunakan mengumpulkan entri di bawah tajuk: Ditambah, Diubah, Dibaiki, Dibuang.

## [1.2.0] - 2024-05-01
### Added
- Search filters
### Fixed
- Login redirect bug

Komit Konvensional

Komit konvensional menggunakan awalan seperti feat:, fix: dan BREAKING CHANGE: supaya alat boleh menjana log perubahan secara automatik.

feat: add CSV export
fix: handle empty cart
feat!: drop Node 14 support

Menyenaraikan Komit sejak Teg

Anda boleh melihat pratonton perubahan sejak keluaran terakhir menggunakan git log dengan julat teg.

git log v1.1.0..HEAD --oneline

Log Kemas untuk Nota

Formatkan log menjadi baris bertanda bulet yang sesuai untuk ditampal ke dalam nota keluaran.

git log v1.1.0..HEAD --pretty=format:'- %s'

Alat Log Perubahan Automatik

Alat seperti standard-version atau conventional-changelog membaca komit konvensional dan menjana log perubahan serta peningkatan versi.

npx standard-version

Nota Dijana Automatik oleh GitHub

GitHub boleh menjana nota keluaran secara automatik daripada permintaan tarik yang digabungkan apabila anda mencipta keluaran.

gh release create v1.2.0 --generate-notes

Mengelaskan dengan Label

Fail .github/release.yml memetakan label PR kepada bahagian log perubahan, supaya nota mengumpulkan pembaikan pepijat dan ciri secara automatik.

changelog:
  categories:
    - title: Features
      labels: [feature]

Menyemak Sebelum Menerbitkan

Sentiasa baca nota yang dijana sebelum menerbitkannya. Automasi menyediakan draf, tetapi manusia menyunting perumusan dan menyerlahkan perubahan yang memecahkan keserasian.

Memautkan kepada Keluaran

Pastikan setiap entri log perubahan dipautkan kepada teg Git dan halaman keluaran supaya pembaca boleh pergi ke perbezaan tepat.

[1.2.0]: https://github.com/you/repo/compare/v1.1.0...v1.2.0

Semakan Pantas

Uji pemahaman anda tentang log perubahan dan nota keluaran.

Jawab dalam pelajaran interaktif

Imbas Kembali

Anda telah mempelajari cara menjana log perubahan:

Gunakan format Keep a Changelog
Komit konvensional menggerakkan automasi
git log v1..HEAD memberikan pratonton perubahan
gh release create --generate-notes menyediakan draf nota daripada PR

Percuma untuk bermula

Pelajari Aliran Kerja Profesional Git dan GitHub dengan tutor kecerdasan buatan — percuma

Tulis dan jalankan kod sebenar dalam pelayar anda, dapatkan bantuan segera daripada tutor kecerdasan buatan yang tersedia 24/7, dan sambung semula dari tempat anda berhenti di web atau dalam aplikasi.

Kursus: 12
Pelajaran: 48

Mula belajar secara percuma Lihat kursus penuh

Soalan Lazim

Adakah pelajaran “Menjana Changelog dan Nota Keluaran” percuma?

Ya — teks penuh “Menjana Changelog dan Nota Keluaran” boleh dibaca secara percuma di web ini. Untuk berlatih secara interaktif menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7, serta membuka kunci baki kursus Aliran Kerja Profesional Git dan GitHub, tingkat taraf kepada CoddyKit PRO. Kursus Aliran Kerja Profesional Git dan GitHub merangkumi sejumlah 4 pelajaran.

Apakah yang akan saya pelajari dalam “Menjana Changelog dan Nota Keluaran”?

Pelajari cara menghasilkan changelog dan nota keluaran automatik yang jelas daripada sejarah Git dan komit konvensional. Anda berlatih Aliran Kerja Profesional Git dan GitHub menggunakan kod praktikal yang dijalankan terus dalam pelayar, manakala tutor kecerdasan buatan 24/7 menjawab soalan anda semasa anda mengikuti pelajaran.

Adakah saya memerlukan pengalaman untuk memulakan Aliran Kerja Profesional Git dan GitHub?

Tiada pengalaman terdahulu diperlukan. Pembelajaran Aliran Kerja Profesional Git dan GitHub di CoddyKit disusun untuk pelajar daripada peringkat pemula hingga lanjutan, jadi anda boleh bermula di sini atau dari awal dan belajar mengikut kadar anda sendiri. Ini ialah pelajaran 4 daripada 4.

Berapa lamakah pelajaran “Menjana Changelog dan Nota Keluaran” diambil?

Kebanyakan pelajaran CoddyKit mengambil masa kira-kira 5–10 minit. Setiap pelajaran ringkas dan interaktif, jadi anda boleh membuat kemajuan secara berterusan dan menyambung tepat dari tempat anda berhenti di web atau aplikasi.

Bolehkah saya menulis dan menjalankan kod dalam pelajaran Aliran Kerja Profesional Git dan GitHub ini?

Ya. Setiap pelajaran Aliran Kerja Profesional Git dan GitHub menyertakan penyunting kod terbina dalam, jadi anda boleh menulis dan menjalankan kod sebenar terus dalam pelayar serta menerima maklum balas kecerdasan buatan serta-merta — tanpa memerlukan persediaan setempat.

Semua pelajaran dalam kursus ini

← Kembali ke Aliran Kerja Profesional Git dan GitHub