Cách dùng Trình tạo Changelog
- Chạy lệnh
git logđược hiển thị ở trên trong repository của bạn rồi dán kết quả vào (mỗi dòng gồm hash và tiêu đề commit). - Nhập phiên bản hiện tại; phiên bản phát hành sẽ được gợi ý dựa trên các commit, hoặc bạn có thể tự nhập.
- Chọn kiểu tiêu đề Conventional hoặc Keep a Changelog, rồi thêm URL repository để liên kết các hash commit.
- Sao chép Markdown vào đầu file
CHANGELOG.mdcủa bạn hoặc vào một GitHub release.
Conventional Commits trong 30 giây
Tiêu đề mỗi commit bắt đầu bằng một loại (type), tùy chọn phạm vi (scope) và phần mô tả: feat(cart): add coupon field. Dấu ! sau type/scope hoặc ghi chú BREAKING CHANGE: đánh dấu một breaking change.
| Loại | Mục | Tăng phiên bản |
|---|---|---|
feat | Features / Added | Minor |
fix | Bug Fixes / Fixed | Patch |
perf | Performance | Patch |
feat!, BREAKING CHANGE | Breaking Changes | Major |
refactor, docs, style, test, build, ci, chore | Khác / ẩn | Không |
revert | Reverts | Patch |
Keep a Changelog
Keep a Changelog nhóm các mục dành cho người dùng đọc dưới Added, Changed, Deprecated, Removed, Fixed, Security, bản phát hành mới nhất đứng đầu, với mục Unreleased ở trên cùng. Hãy chọn kiểu này nếu người dùng của bạn đọc changelog thay vì lập trình viên.
Từ changelog đến bản phát hành
Kiểm tra phiên bản gợi ý bằng Semantic Version Calculator, cập nhật version trong package.json, sau đó tạo tag và push bản phát hành. Git Command Generator có sẵn các lệnh cần dùng. GitHub Actions workflow có thể tự build và publish mỗi khi có tag.
Cũng được tìm dưới tên: tạo changelog, conventional commits changelog, keep a changelog, viết release notes tự động, changelog.md, git log changelog, tạo release notes, conventional commits.
Các công cụ dùng kèm tốt với Trình tạo Changelog
- Tạo Conventional Commit — Viết commit message theo chuẩn Conventional Commits mà không cần nhớ cú pháp.
- Trình tạo README — Điền vài trường thông tin để nhận một file README.md gọn gàng, sẵn sàng cho GitHub: huy hiệu, cách cài đặt, ví dụ sử dụng, bảng cấu hình, biến môi trường, lộ trình và giấy phép.
- Kiểm tra YAML — Dán file Docker Compose, manifest Kubernetes, workflow GitHub Actions hoặc bất kỳ YAML nào để xác định chính xác lỗi, phát hiện các lỗi thường gặp và nhận bản đã định dạng gọn gàng.
- Tạo Kubernetes YAML — Nhập tên ứng dụng, image và cổng, bạn sẽ có ngay Kubernetes YAML sẵn sàng cho production: một Deployment với probe, giới hạn tài nguyên và security context được gia cố, cùng Service, Ingress có TLS, ConfigMap, Secret và HorizontalPodAutoscaler mà bạn chọn — tất cả trong một file, sẵn sàng cho kubectl apply.
Câu hỏi thường gặp
Tôi nên dán định dạng git log nào?
git log --pretty=format:"%h %s". Chỉ có tiêu đề commit không kèm hash cũng vẫn hoạt động. Các merge commit sẽ được bỏ qua tự động.