Changelog fragment check fails every release PR that bumps the version

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#587 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github-actions, python
Lĩnh vực
ci-cd, release

Hướng nghiên cứu

Bắt đầu với scripts/check_changelog_fragment.py và job static trong ci.yml; so sánh cách bước kiểm tra xử lý các thay đổi của project.version và những fragment đã bị xóa. Đọc docs/releasing.md để đánh giá quy trình phát hành được ghi lại và hai cách khắc phục được đề xuất. Công việc hoàn tất khi một PR phát hành theo hướng dẫn đó vượt qua job static.

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

Mô tả

The Fragment for package changes step (scripts/check_changelog_fragment.py, static job in ci.yml) fails on every release PR that bumps the version.

A release PR changes project.version in dokimi/pyproject.toml, which the check counts as an install-metadata change, and scriv collect has just deleted every fragment, so there is none to add. #586 (0.2.0) failed this way and needed the skip-changelog label. #128 (0.1.0) passed only because the version was already set by #39.

docs/releasing.md does not mention the label, so the next release hits the same failure.

Options:

  • let the check pass a PR whose only package change is project.version and that deletes fragments into a new CHANGELOG.md section, or
  • add the skip-changelog label step to docs/releasing.md.

Done when a release PR following docs/releasing.md passes the static job.

Ngôn ngữ chính
Python
Star
11
Fork
9
Merge trung bình
1 ngày 9 giờ
Pull request đã merge (30 ngày)
442

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 intel/dokimi

Tất cả issue của intel/dokimi

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.