Changelog
Changelog
Phần tiêu đề “Changelog”Hệ sinh thái NextPDF trải rộng trên nhiều gói và kho lưu trữ. Trang này cho biết cách hệ sinh thái ghi nhận thay đổi và nơi từng gói lưu changelog riêng. Hãy xem đây như một chỉ mục và tài liệu tham khảo về quy ước, không phải bản nêu lại từng commit. Mỗi gói lưu changelog phát hành chính thức trong kho lưu trữ riêng. Bảng tóm tắt chỉ tổng hợp loại thay đổi theo từng phiên bản đã phát hành, dựa trên lịch sử Conventional Commits của mỗi kho lưu trữ.
Vì là chỉ mục tài liệu, trang này không đưa ra tuyên bố nào về hành vi của bất kỳ gói nào. Để xem các quy tắc mà mỗi gói tuân theo khi viết commit và tạo bản phát hành, hãy xem Quy ước changelog.
Cách ghi lại thay đổi
Phần tiêu đề “Cách ghi lại thay đổi”Mọi kho lưu trữ NextPDF công khai đều tuân theo hai quy ước:
- Conventional Commits 1.0.0 — mỗi tiêu đề commit có dạng
type(scope): description, trong đótypelà một trongfeat,fix,perf,refactor,docs,test,build,ci,chore, hoặcrevert. Dấu!sau type/scope hoặc footerBREAKING CHANGE:đánh dấu thay đổi không tương thích. Các bản sửa lỗi liên quan đến bảo mật được gắn thẻ để có thể lọc. - Semantic Versioning 2.0.0 — một
featnâng phiên bản minor, mộtfix/perfnâng phiên bản patch, và một thay đổi gây mất tương thích nâng phiên bản major. TệpCHANGELOG.mdđược phát hành trong mỗi kho lưu trữ nhóm các mục dễ đọc theo phiên bản, dùng các phần Keep a Changelog.
Bản tóm tắt bên dưới chỉ bao gồm các loại hướng đến người dùng: feat (năng lực mới), fix (sửa hành vi), perf (hiệu năng), security (sửa lỗi liên quan đến bảo mật), và các thay đổi gây mất tương thích. Các loại commit chỉ dùng nội bộ (docs, test, ci, chore, refactor) được cố ý loại khỏi bản tóm tắt liên kho lưu trữ. Các loại này không thay đổi những gì bạn quan sát được khi sử dụng gói.
Nơi lưu changelog của mỗi gói
Phần tiêu đề “Nơi lưu changelog của mỗi gói”Changelog chính thức dạng văn xuôi của một gói là tệp CHANGELOG.md trong kho lưu trữ riêng của gói đó, được nhóm theo phiên bản đã phát hành. Để xem toàn văn từng mục, hãy dùng trang phát hành của kho lưu trữ hoặc tệp CHANGELOG.md của gói đó. Chỉ mục này không sao chép lại phần văn bản đó.
| Gói | Kho lưu trữ | Changelog chính thức |
|---|---|---|
nextpdf/core | nextpdf | CHANGELOG.md (Keep a Changelog) |
nextpdf/server | nextpdf-server | CHANGELOG.md |
nextpdf/laravel | nextpdf-Laravel | CHANGELOG.md |
nextpdf/symfony | nextpdf-Symfony | CHANGELOG.md |
nextpdf/codeigniter | nextpdf-CodeIgniter | CHANGELOG.md |
nextpdf/artisan | nextpdf-Artisan | CHANGELOG.md |
nextpdf/gotenberg | nextpdf-Gotenberg | CHANGELOG.md |
nextpdf/cloudflare | nextpdf-Cloudflare | CHANGELOG.md |
nextpdf/compat-legacy | nextpdf-compat-tcpdf | CHANGELOG.md |
nextpdf (Python bindings) | nextpdf-python | CHANGELOG.md |
Bản tóm tắt liên kho lưu trữ — các loại thay đổi theo phiên bản phát hành mới nhất
Phần tiêu đề “Bản tóm tắt liên kho lưu trữ — các loại thay đổi theo phiên bản phát hành mới nhất”Bảng chỉ đọc này được tạo từ lịch sử Conventional Commits của mỗi kho lưu trữ tại thẻ phát hành mới nhất. Bảng đếm các loại hướng đến người dùng và chỉ báo cáo số lượng theo loại — không bao giờ là tiêu đề commit thô — nên không để lộ định danh nội bộ, tên nhánh hay tham chiếu kế hoạch. Để biết phần diễn giải văn xuôi tương ứng với bất kỳ dòng nào, hãy xem tệp CHANGELOG.md của chính gói đó.
| Gói | Phát hành mới nhất | Năng lực mới (feat) | Sửa lỗi (fix) | Hiệu năng (perf) | Bảo mật | Mất tương thích |
|---|---|---|---|---|---|---|
nextpdf/core | v5.2.0 | 317 | 290 | 1 | 1 | có |
nextpdf/server | v0.1.0 | 15 | 16 | 0 | 0 | không |
nextpdf/laravel | v0.1.0 | 1 | 8 | 0 | 0 | không |
nextpdf/symfony | v0.1.0 | 1 | 7 | 0 | 0 | không |
nextpdf/codeigniter | v0.1.0 | 1 | 10 | 0 | 0 | không |
nextpdf/artisan | v0.1.0 | 1 | 7 | 0 | 0 | không |
nextpdf/gotenberg | v0.1.0 | 0 | 6 | 0 | 0 | không |
nextpdf/cloudflare | v0.1.0 | 0 | 8 | 0 | 0 | không |
nextpdf/compat-legacy | v0.1.0 | 1 | 8 | 0 | 0 | không |
nextpdf (Python) | v1.1.0 | 7 | 5 | 0 | 0 | không |
Các số đếm được tích lũy đến thẻ được nêu tên. Với mỗi gói tích hợp, bản phát hành được gắn thẻ đầu tiên bao gồm toàn bộ lịch sử trước 1.0 của gói đó. Ô “Breaking” của
nextpdf/corehiển thịyesvì engine lõi đã phát hành các phiên bản major gây mất tương thích. Chi tiết theo từng phiên bản và lộ trình di chuyển cho mỗi phiên bản nằm trong tệpCHANGELOG.mdcủa kho lưu trữ lõi và các hướng dẫnmigration/của nó. Chỉ mục này không nêu lại chúng.
Những gì trang này cố ý bỏ qua
Phần tiêu đề “Những gì trang này cố ý bỏ qua”Để changelog công khai không làm rò rỉ thông tin nội bộ, chỉ mục này không bao giờ để lộ bất kỳ điều nào sau đây:
- tiêu đề hoặc nội dung commit thô;
- định danh issue, ticket, cycle, wave nội bộ hoặc định danh hạng mục công việc;
- tên nhánh riêng tư hoặc công việc đang dang dở chưa phát hành;
- lộ trình hoặc tính năng chưa công bố;
- thông tin ghi công của tự động hóa từ người đóng góp.
Một thay đổi chỉ xuất hiện ở đây sau khi trở thành một phần của phiên bản được gắn thẻ và đã phát hành của một gói công khai. Công việc chưa phát hành sẽ không xuất hiện.