Release Note

1. Khái niệm

Release Note là một tài liệu kỹ thuật được công bố cùng với các bản cập nhật mới của phần mềm. Mục đích chính của nó llaf thông báo cho người dùng, tester, và các thành viên khác trong team biết những gì đã thay đổi so với phiên bản trước đó.

Release Note quan trọng vì:

• Minh bạch: Giúp khách hàng, người dùng biết họ nhận được giá trị gì mới.
• Hướng dẫn Tester: QA, Tester nhìn vào Release Note để biết cần tập trung test tính năng nào và kiểm tra bug nào đã được fix.
• Cảnh báo rủi ro: Thông báo cho đội ngũ kỹ thuật nếu bản cập nhật yêu cầu thay đổi cấu hình, cập nhật database, hoặc code cũ không còn tương thích

2. Cấu trúc

Một Release Note thường gồm các mục sau:

• Header: bao gồm
  • Phiên bản (Ví dụ: v1.2.0)
  • Ngày phát hành (Ví dụ: 2024-01-07)
• Phân loại nội dung
  • New Features: Những chức năng mới (Ví dụ: Thêm chức năng xuất file SVG trong Editor)
  • Bug fixes: Những lỗi đã được khắc phục (Ví dụ: Sửa lỗi không lưu được avatar khi mạng yếu)
  • Improvements: Những thay đổi nhỏ giúp hệ thống hoạt động tốt hơn (Ví dụ: Tăng tốc độ tải trang dashboard lên 20%)
  • Breaking Changes (rất quan trọng cho Dev): Những thay đổi làm code cũ không chạy được hoặc cần thao tác thủ công (Ví dụ: API /user/info đổi thành /user/profile. Cần chạy lại migration database)

Lưu ý: Trong thực tế, Release Note thường không chứa tất cả những nội dung trên, có thể ít hơn tùy theo phiên bản.

Ví dụ:

3. Quản lý Release Note trên Jenkins

Nội dung bên dưới dành cho nhân viên Marvy

Tại trang Jenkins của Octokit, sẽ có job tên “Manage-Release-Notes”, truy cập vào job -> Build with Parameters. Tại đây ta sẽ thấy trang quản lý Release Note như bên dưới

Tại đây ta sẽ thấy 2 thành phần chính: Tag và Release History.

Tag sẽ hiển thị danh sách toàn bộ tag giống với rollback, mục đích là hỗ trợ việc đánh Release Note. Release History sẽ hiển thị danh sách 100 Release Note gần nhất của dự án. Khi bấm vào 1 tag, hệ thống sẽ tìm Release Note của tag đó và hiển thị nổi bật lên, nếu không có sẽ báo không tìm thấy. Nếu release note quá cũ (>100) thì cần phải vào Git xem, do giới hạn API Git chỉ trả về 100 release note.

Để tiến hành đánh Release Note, ta sẽ chọn 1 tag trước, tag đó sẽ được dùng để làm Header cho Note, kế tiếp nhập nội dung và bấm Build. Nếu tag đã có Release Note trước đó thì sẽ tiến hành Edit thay vì tạo mới.