Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Release Notes: Ignore Issue Title if there are release notes written within a given ticket

Đang mở
#40 4 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
github-actions, python
Lĩnh vực
release, tooling

Hướng nghiên cứu

Bắt đầu bằng việc tìm nơi action phân tích nội dung issue để lấy Release Notes và nơi định dạng từng issue thành bản nháp release cuối cùng. Sử dụng các ví dụ trong issue làm hành vi mong đợi: các issue có Release Notes phải bỏ qua tiêu đề issue, trong khi các issue không có Release Notes phải giữ lại tiêu đề. Tùy chọn có thể cấu hình được đề cập nhưng chưa được đặc tả, vì vậy hãy xác nhận phạm vi trước khi triển khai.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement

Background

Ignore Issue title if a given Issue has Release Notes in it. I find this to potentially improve the readability of our Releases - let's keep the information brief but detailed enough and tidy.

Or even better, make it configurable.

Example

Imagine that you have tickets 111 and 112, as detailed below.

Ticket 111 (author A1 worked on it)

Title: Implement Algorithm BFS for problem X

Release Notes

  • BFS implemented for problem X
  • Optimized the backend part Y by Z amount of % on average
Ticket 112 (author A2 worked on it)

Title: Enhancing Monitoring of the service Q

(and this ticket would have no release notes)


Final Release Draft would look like this:

...

New Features 🎉
  • #111 by @ A1

    • BFS implemented for problem X
    • Optimized the backend part Y by Z amount of % on average
  • #112 Enhancing Monitoring of the service Q by @ A2

...

Ngôn ngữ chính
Python
Star
13
Fork
0
Merge trung bình
1 phút
Pull request đã merge (30 ngày)
5

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của AbsaOSS/generate-release-notes

Tất cả issue của AbsaOSS/generate-release-notes

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.