release runner: refuse a changelog entry that a second Prettier pass changes

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#588 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
78/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, node.js
Lĩnh vực
tooling

Hướng nghiên cứu

Bắt đầu từ scripts/release-please-runner.js và đọc formatChangelogMarkdown, sau đó kiểm tra hướng dẫn liên quan trong scripts/README.md và DEVELOPMENT.md. Tái hiện vấn đề bằng đoạn mã được cung cấp sau npm --prefix scripts ci; bổ sung kiểm thử cho các mục không bao giờ kết thúc, có và không có *. Hoàn tất khi runner từ chối mục đó và nêu dòng đầu tiên bị thay đổi, đồng thời hướng dẫn không còn khẳng định những văn bản nào sẽ kết thúc.

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

Mô tả

needs-triage

The release runner can write a changelog entry that a second Prettier pass changes.

Defect. scripts/release-please-runner.js formats the new CHANGELOG entry with one Prettier pass. For some entries a second pass changes the text again. mise run format-check then fails on the release PR, and mise run format changes the words of the entry.

Reproduction (main, after npm --prefix scripts ci):

const r = require("./scripts/release-please-runner.js");
const a = r.formatChangelogMarkdown("## [0.4.0]\n\n- Fixed open_in_new_tab when *focus* is false\n");
// a, line 3:           "- Fixed open_in_new_tab when _focus_ is false"
// second pass, line 3: "- Fixed open*in_new_tab when \\_focus* is false"
r.formatChangelogMarkdown(a) === a; // false

#567 only documents this: its refusal message, scripts/README.md and DEVELOPMENT.md tell a maintainer to review the diff, fix such a line by hand, and run mise run format until it changes nothing.

Planned fix. Run the formatter a second time on the new entry and refuse with an error that names the first line the second pass changes (one more Prettier call per update). Trim the README and refusal text so they claim nothing about which texts settle. Test with a never-settling entry with and without *.

Owner: the next change to the release runner. Deferred from the README verification run with the maintainer's agreement.

Generated with xum • Model: anthropic:claude-opus-5-5 • Thinking: high

Ngôn ngữ chính
Lua
Star
3.2k
Fork
223
Merge trung bình
6 giờ 7 phút
Pull request đã merge (30 ngày)
210

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

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

  • Không có Dockerfile hay tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

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 coder/claudecode.nvim

Tất cả issue của coder/claudecode.nvim

Issue tương tự

Thêm issue về Lua

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.