[Feature] Hiển thị danh sách thay đổi, update(changelog) trên website

[nvatuan]

Mình muốn trên web bkdnOJ có một mục để hiển thị những update mới, thay đổi mới, giống như changes log để mọi người có thể thấy và test được. Cái này mình chia làm 3 event:

1. Khi nhánh main có commit mới nhưng build hiện tại sử dụng commit cũ. Mình gọi event này là Need Update.
2. Khi nhánh main được build sử dụng commit mới trong 1 tuần gần đây. Mình gọi event này là New Changes.
3. Khi nhánh main được build sử dụng commit cũ hơn 1 tuần. Mình gọi event này là Normal.

Event

Mỗi event có thể làm thêm một clickable label trên Header, nhấn vào sẽ mở ra một modal, như sau:

1. Need Update:
   • Khi mới mở trang, label sẽ show Changelog [Update Now]:
   • Sau đó 3s, text [Update Now] sẽ collapse trở thành một icon mũi tên lên trên (biểu tượng đại diện cho update)
   • Thể hiện việc cần update bằng sắc xanh dương + xám (ví dụ: background: cadetblue;)
2. New Changes:
   • Khi mới mở trang, label sẽ show Changelog [New Changes]:
   • Sau đó 3s, text [New Changes] sẽ collapse trở thành một inline icon hoặc một inline svg như sau:
   • Thể hiện new changes bằng sắc đỏ, đỏ (ví dụ: background: darkred;
3. Normal:
   • Bình thường không gì cả. Chỉ có mỗi label "Changelog" (Như nhãn bugs bên cạnh)

Biểu hiện khi nhấn vào:

• Show một modal, sắp xếp các changes từ gần nhất đến xa nhất. Có thể chỉ show max 10-20 changes, hoặc phân trang theo kiểu (prev, next) chứ không cần show số trang.
• Mỗi mục update tương ứng với một issue. Hoặc nếu khó quá thì link commit cũng được.

Comment

• Cái này phía backend chưa có API và mình cũng không muốn tạo một dedicated API cho việc này lắm, liệu có cách nào ta sử dụng API Github, hay nhúng github vào trong ReactJS hay tự code crawler phía Frontend?
• Có thể chúng ta sử dụng một 3rd service nào đó, nhưng sẽ đồng nghĩa với việc maintain những task/pull bên github và changelog bên đó (phải update 2 list), nên giải pháp này mình đánh giá không nên.
• Với cấu trúc project hiện tại và các chúng ta commit, tạo issue, tạo pull request có thể sẽ không phù hợp với yêu cầu changelog, nhờ mọi người đề xuất format để từ nay chúng ta tuân theo sao cho cái changelog nó chạy được.

[nvatuan]

Nhờ @trinhdvt góp ý chút về độ khả thi, khối lượng công việc và các hướng giải quyết. Chưa cần làm liền đâu.

[trinhdvt]

Đỉnh rứa bro.

• Cái Changelog [Update Now] có vẻ hơi khó làm vì cũng không biết detect kiểu gì. Mà tui thấy cái hiển thị Update Now này đâu cần thiết đâu nhỉ ?
• Còn về xử lý thì kiểu gì cũng phải tạo API bên backend thui. Dùng Github API hay 3rd party thì cũng phải lưu TOKEN của nó bên server.
• Nếu hiển thị changelog bằng cách list các commit ở branch main thì chắc dùng Github API là nhanh nhất, mà nó chỉ có thể lấy cái PR dính với commit chứ ko lấy issue được.
• Vì call Github API cũng có giới hạn nên có vẻ cũng phải cân nhắc tới việc tạo database cho cái đó hoặc cache lại

Một vài hướng cho việc hiển thị Changelog:

• 1️⃣ Dùng Github API lấy toàn bộ commit và xem mỗi commit là một change 😃
• 2️⃣ Viết Release Notes bên Github (làm như này thì mình có thể nhóm nhiều commit tạo thành một change). Sau đó:
  • Tạo cái link trên web rồi họ click vào thì mở ở tab mới cho họ đọc 😶
  • Hoặc dùng Github API lấy dữ liệu rồi tự hiện lên.
• 3️⃣ Thêm chức năng viết changelog cho admin rồi tự viết luôn. Mà như này thì mỗi lần bro update thì thầy cũng phải tự update theo 😕