Skip to content

fix(util): match the PR template's changelog box in issue_pr_kinds.body - #2788

Merged
JarryShaw merged 1 commit into
mainfrom
fix/issue-pr-kinds-changelog-box
Nov 5, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
fix/issue-pr-kinds-changelog-box

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • fix — corrects a defect

Description of your pull request and other information

util/issue_pr_kinds.body is meant to mark the PR template's changelog box "N/A — centralised". Its regex still looked for the box's old wording ("Added a [changelog entry]"), which #2483 reworded. As a result it matched nothing and the suffix was never applied.

The regex now finds the box by its [changelog entry] link, so rewording the text around it cannot break it again. A new test runs the real template through body() and checks that the suffix appears exactly once. It fails on main and passes with the fix.

The #2786 sweep found this. No issue tracks it.

@JarryShaw JarryShaw added chore Maintenance work: tooling, repo hygiene, no library behaviour change review: running A cross-review is in flight against the current head - no verdict yet labels Nov 5, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Nov 5, 2026
@github-actions github-actions Bot added this to the PyPCAPKit v1.6 milestone Nov 5, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at f140b48ff. A Sonnet cross-review confirmed:

  • the new regex matches exactly the template's changelog box, and only that line;
  • body() output changes only there, where the suffix is now added once;
  • the new test fails on main and passes here, and nothing else calls body() beyond the publish cron.

One thing for you, not blocking: the suffix the fix now applies reads "N/A — centralised in #657". #657 is the 1.5.0 changelog PR, and later releases centralise in their own PR. A version-neutral "N/A — centralised" may read better, so say if you want it changed here.

CI: the one failed check, Project tests (test_doc_comment_first_line_2745_unit), is inherited from main and not caused by this PR. My docs push left two __proto_key__ doc-comments with a colon on their first line. efede2c18 has fixed that on main, and this PR changes no doc-comment. Every other check is green. The PR is only behind main, so no rebase is needed.

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: running A cross-review is in flight against the current head - no verdict yet labels Nov 5, 2026
@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Coverage: 94.46% (unit tier, Python 3.15, 61bb1e8d2, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 106 4 20 2 95.24%
pcapkit/const 20918 175 2908 156 98.57%
pcapkit/corekit 2918 77 942 38 96.81%
pcapkit/dumpkit 286 3 102 3 98.45%
pcapkit/foundation 3512 27 1218 32 98.75%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 22840 157 5950 127 99.00%
pcapkit/toolkit 961 26 342 8 96.62%
pcapkit/utilities 574 7 156 5 98.36%
pcapkit/vendor 5590 2286 1280 214 55.75%

Per-file detail: the coverage-html artifact of this run.

#2483 reworded the template's changelog box, so the `Added a` pattern matched nothing and
the refresh pull request's box never got its N/A suffix. Find the box by its link instead;
a new test feeds the real template through body() and fails without the fix.
@JarryShaw
JarryShaw force-pushed the fix/issue-pr-kinds-changelog-box branch from f140b48 to 61bb1e8 Compare November 5, 2026 07:26
@JarryShaw

Copy link
Copy Markdown
Owner Author

Rebased onto main (efede2c18), which fixes the inherited doc-comment failure that turned Project tests red here: f140b48ff → 61bb1e8d2, same patch-id. The verdict stands.

@JarryShaw
JarryShaw merged commit 0dcbf9f into main Nov 5, 2026
64 checks passed
@JarryShaw
JarryShaw deleted the fix/issue-pr-kinds-changelog-box branch November 5, 2026 13:13
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Nov 5, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Nov 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Maintenance work: tooling, repo hygiene, no library behaviour change

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant