chore(docs): centralise changelog entries for unreleased versions by JarryShaw · Pull Request #2483 · JarryShaw/PyPCAPKit

JarryShaw · 2026-10-31T01:57:16Z

Please follow the guide below

Searched for similar pull requests
Followed the coding style
make test passes, and a test case covers the change (tests/project/test_pr_template_commit_types_1102_unit.py and tests/project/test_python_versions_update_1660.py run)
Described the user-visible change below and left its changelog entry to the maintainer (N/A)

What is the purpose of your pull request?

chore — anything else

Description of your pull request and other information

Feature PRs no longer add entries under docs/source/changelog/ or to CHANGELOG.md; the maintainer writes them centrally. CONTRIBUTING.md says so, and this PR also rewords the template's changelog box to match (not deferred). util/update_python_versions.py and its test follow the new box wording. No runtime code or release content changed.

JarryShaw · 2026-10-31T02:06:16Z

NEEDS CHANGES (Sonnet, 30953ed00). CONTRIBUTING.md change is correct and contained; no code, release content or counts changed.

.github/PULL_REQUEST_TEMPLATE.md still tells contributors to add an entry and regenerate CHANGELOG.md, and links to the section this PR rewrites. Reword it in this PR, with util/update_python_versions.py (~L1301) and tests/project/test_python_versions_update_1660.py (~L879), which pin the current wording.
If the template is instead deferred, the body must say so and Closes #2449 becomes Refs #2449.
Non-blocking: "Feature pull requests" (L61) is narrower than L28; "Open" (L61) is undefined; L28 is 125 columns.

JarryShaw · 2026-10-31T02:18:59Z

NEEDS CHANGES (Sonnet, 4f2af68ee). Regex and pinned test verified; no code changed.

CONTRIBUTING.md ~L69 is 102 columns. Break before "the" so line 70 starts "the .rst entry, then regenerates:".
PULL_REQUEST_TEMPLATE.md ~L10: "described … above" should say "below" (the description is below the checklist); update test_python_versions_update_1660.py ~L879 to match.
Non-blocking: "Feature branches" (CONTRIBUTING ~L64), "docs-only" in the body (the diff touches util/ and tests/), "open versions" in the title.

Pull requests for user-visible changes each adding a bullet to the unreleased version's changelog file conflict on every merge. CONTRIBUTING.md now says the maintainer writes those entries centrally, and that such PRs leave the file out of the diff. The PR template's changelog box and the generator that annotates it follow the same rule. Refs #2449

github-actions · 2026-10-31T03:53:25Z

Coverage: 94.45% (unit tier, Python 3.15, 0cd0d2044, 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`	2913	77	940	38	96.81%
`pcapkit/dumpkit`	286	3	102	3	98.45%
`pcapkit/foundation`	3506	27	1216	32	98.75%
`pcapkit/interface`	138	4	52	3	96.32%
`pcapkit/protocols`	22834	157	5952	127	99.00%
`pcapkit/toolkit`	961	26	342	8	96.62%
`pcapkit/utilities`	559	7	150	5	98.31%
`pcapkit/vendor`	5590	2286	1280	214	55.75%

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

JarryShaw · 2026-10-31T06:37:36Z

Local-only commit 30953ed forks from 4ca3f30 and is redundant with origin a9db8a4 (rebase onto origin is empty). Nothing to push. Local commit to be dropped.

JarryShaw · 2026-10-31T16:12:08Z

Add to convention and session/sweep memo: upon each release, amend inline or post updates in thread to the PEP's Discussion post. PEP doc is source of truth but aim to keep the Discussion also up-to-date.

JarryShaw · 2026-10-31T16:14:44Z

Ruling reconciled: upon each release, amend pep.rst inline and update Discussion #106 ("PyPCAPKit Enhancement Proposals") to match -- the page stays authoritative. Documented in process.rst (20f39eb73) and in the sweep memo.

JarryShaw · 2026-11-01T06:19:21Z

Owner ruling (2026-11-01), paraphrased: changelog entries are consolidated in this PR and stripped from the open feature PRs, so they stop conflicting. The ruling named #2383, which is a merged HIP fix, so I've taken it to mean this PR (it implements #2449's practice). Say so if that's wrong.

In flight on this branch: merge current main, add #2509's Radiotap entry, and reconcile the 1.6.0 entries this merge wave left stale. When that is pushed, the label resets to review: pending and a fresh review runs.

- add entries for the user-visible changes merged since 1.5.1 that had none: LinuxSLL, ICMP/ICMPv6, IGMP, TLS/DTLS, SSLv2, DTLS reassembly, IP_Pseudo, the IPv6 extension-header walk and the IPv6_Ext id() and membership fixes - add the Radiotap entry from #2509 - drop the FRAD, Netlink and GRE entries' stale "remain Raw" and "tracked separately" notes, and cite each entry's own PR and issue - record the centralised-changelog rule this PR introduces - regenerate CHANGELOG.md; util/changelog_md.py --check passes

- #2766 (Fixed): a cut list of plain values ends with the data, where 1.5.x read zero values past the cut (a cut Type 0 Routing header, measured on v1.5.1), into the ListField entry; IGMPv3's sources and the Query's num_sources, into the IGMP entry. - #2767: a cut header rebuilt on its own reads back its parsed values, a regression of the 1.6.0 rebuild path, into the cut-header Fixed entry; the round-trip test rule, into the conventions entry. - #2764: SSLv2, TLS and DTLS records rebuild from their to_dict(), into the TLS/DTLS Added entry, as those classes never shipped. - #2765: the further member reorders and guard rules, into the member-order entry, which records the earlier #2490 reorders. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

- Breaking (#2770), a new entry after the package layout one: pcapkit.protocols.__proto__, a dict keyed by upper-cased name in 1.5.1, is removed with no alias; ProtocolBase.__registry__, get_protocol(), register_protocol() and the read-only registry view replace it, and a concrete Protocol subclass registers itself, measured against v1.5.1. The ruling goes into the conventions entry. - The lazy-import entry no longer describes the removed registry module, which never shipped and stays unnamed. - 1.5.0's __proto__ role points at ProtocolBase.__registry__, its text unchanged, so the nitpicky build does not warn on it. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

JarryShaw · 2026-11-04T17:50:31Z

NEEDS CHANGES at f865c75a5 (Sonnet cross-review, verified against v1.5.1)

refactor(protocols)!: replace the pcapkit.protocols.__proto__ dict with ProtocolBase.__registry__ (#2763) #2770 entry is wrong about 1.5.x. It says 1.5.x registered a Protocol subclass only through register_protocol. In fact v1.5.1's Protocol.__init_subclass__ calls register_protocol(cls) itself, so subclasses already registered on definition. What 1.6.0 changes is narrower: an abstract subclass is now skipped, and a name clash keeps the existing entry and warns with RegistryWarning.
fix(protocols): rebuild a cut standalone header with the values its parse read (#2761) #2767 sentence overclaims. "its Reserved octets, option area and length among them" includes IPv6_Ext's length at cut 1, which is still open on fix(protocols): a cut standalone IPv6 extension header rebuilds with values its parse did not read #2761. Drop "and length" until fix(protocols): a cut standalone IPv6 extension header rebuilds with values its parse did not read #2761 lands.
Checked and fine: the 1.5.x Routing-header example, the num_sources and TLS/DTLS sentences, the never-released names, the 1.5.0 role retarget, changelog_md.py --check, and the changelog tests.

- #2770: 1.5.1's Protocol.__init_subclass__ already registered a subclass as it was defined. The entry names what changed, measured on a v1.5.1 export: an abstract subclass is skipped, where 1.5.x registered it, and a name clash keeps the existing entry and warns, where 1.5.x replaced it and warned that it was overwriting. - #2767: drops "length", since IPv6_Ext's length at cut 1 is still open on #2761. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

JarryShaw · 2026-11-04T18:20:55Z

CI note on 1818bb3a2: one job failed, Python 3.15 (LATEST tier, half 2). The failure is test_register_restores_shipped_descriptor_1504_unit::test_restoring_imports_nothing, which raises KeyError: 'pcapkit.protocols.link.arp.protocol'.

This PR changes only the changelog. Main passes the same job, and the module passes when run on its own. The cause is in the test: its _unimported helper pops the shipped module from sys.modules on the assumption it is already imported, and since #2757's lazy imports that depends on which tests ran first. A test-only fix goes straight to main. I'll re-run this job after that.

- Fixed, a new entry beside the cut-header one: a whole header rebuilt through from_data reads back what its parse read. An extension header parsed with extension=True rebuilds in that mode, where 1.5.x's rebuild gained next-layer keys, and a rebuilt Shim6 header keeps its protocol, where 1.5.x's was None (#2774); a rebuilt or made TCP header reads its padding past the End of Option List, where 1.5.x read it as empty (#2775). Both measured on a v1.5.1 export. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

JarryShaw · 2026-11-04T19:27:33Z

GOOD TO GO at 0cd0d2044, for the entries folded so far (cross-review of the #2770 correction, and my own read of folds 26–28).

The refactor(protocols)!: replace the pcapkit.protocols.__proto__ dict with ProtocolBase.__registry__ (#2763) #2770 entry is corrected against v1.5.1. A Protocol subclass already registered itself on definition there. 1.6.0 skips abstract subclasses, and on a name clash keeps the existing entry, where 1.5.x replaced it.
The fix(protocols): rebuild a cut standalone header with the values its parse read (#2761) #2767 sentence no longer claims the IPv6_Ext length fix, which landed separately in fix(protocols): rebuild a cut header at the width its parse read it (#2761) #2777.
Fold 28 adds fix(internet): rebuild a whole extension header in the extension mode its parse used (#2768) #2774 and fix(tcp): rebuild a TCP header with the End of Option List padding its parse read (#2769) #2775, checked against a v1.5.1 export.
Main's 1504 test fix is merged in. Project tests, Lint and deploy-pages pass, and changelog_md.py --check is clean.
Please hold the merge until the last fold. fix(protocols): rebuild a cut header at the width its parse read it (#2761) #2777, fix(pcapng): rebuild a block's info with the options and trailer its parse read (#2776) #2778 and the still-open docs(conventions): settle the member-order page wording and align the protocol registry with the other maps (#2772, #2773) #2779 and fix(utilities): concurrent first access to lazy protocol exports deadlocks the import system #2771 get one more fold once they land, so this PR stays last.

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 Oct 31, 2026

JarryShaw added this to PyPCAPKit Oct 31, 2026

JarryShaw moved this to In review in PyPCAPKit Oct 31, 2026

JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 31, 2026

JarryShaw force-pushed the chore/2449-centralize-changelog branch from 30953ed to 4f2af68 Compare October 31, 2026 02:09

JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 31, 2026

JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 31, 2026

JarryShaw force-pushed the chore/2449-centralize-changelog branch from 4f2af68 to a9db8a4 Compare October 31, 2026 02:21

JarryShaw changed the title ~~chore(docs): centralise changelog entries for open versions~~ chore(docs): centralise changelog entries for unreleased versions Oct 31, 2026

JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 31, 2026

Merge remote-tracking branch 'origin/main' into wf/2483

5a970bd

JarryShaw mentioned this pull request Nov 1, 2026

feat(link): add a radiotap dissector for IEEE80211_RADIOTAP on LinuxSLL #2509

Merged

5 tasks done

JarryShaw added 3 commits November 4, 2026 12:21

Merge commit 'e18d66e6f' into fold26

2f7e7b3

Merge commit '3c4b30e2b' into fold27

4353733

This was referenced Nov 4, 2026

fix(internet): rebuild a whole extension header in the extension mode its parse used (#2768) #2774

Merged

fix(tcp): rebuild a TCP header with the End of Option List padding its parse read (#2769) #2775

Merged

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

JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment and removed review: running A cross-review is in flight against the current head - no verdict yet labels Nov 4, 2026

JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Nov 4, 2026

Merge commit '7e6584786' into fold29

342df58

JarryShaw mentioned this pull request Nov 4, 2026

fix(protocols): rebuild a cut header at the width its parse read it (#2761) #2777

Merged

5 tasks done

JarryShaw added 2 commits November 4, 2026 13:46

Merge commit '1c409b842' into fold30

0cd0d20

This was referenced Nov 4, 2026

fix(pcapng): rebuild a block's info with the options and trailer its parse read (#2776) #2778

Merged

docs(conventions): settle the member-order page wording and align the protocol registry with the other maps (#2772, #2773) #2779

Open

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 4, 2026

JarryShaw mentioned this pull request Nov 4, 2026

fix(utilities): serialise first resolution of lazy exports and module descriptors so concurrent imports cannot deadlock (#2771) #2781

Open

5 tasks done

Navigation Menu

Repository navigation

chore(docs): centralise changelog entries for unreleased versions - #2483

chore(docs): centralise changelog entries for unreleased versions#2483
JarryShaw wants to merge 61 commits into
mainfrom
chore/2449-centralize-changelog

JarryShaw commented Oct 31, 2026 •

edited

Loading

Uh oh!

JarryShaw commented Oct 31, 2026

Uh oh!

JarryShaw commented Oct 31, 2026

Uh oh!

github-actions Bot commented Oct 31, 2026 •

edited

Loading

Uh oh!

JarryShaw commented Oct 31, 2026

Uh oh!

JarryShaw commented Oct 31, 2026 •

edited

Loading

Uh oh!

JarryShaw commented Oct 31, 2026

Uh oh!

JarryShaw commented Nov 1, 2026

Uh oh!

JarryShaw commented Nov 4, 2026

Uh oh!

JarryShaw commented Nov 4, 2026

Uh oh!

JarryShaw commented Nov 4, 2026

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

JarryShaw commented Oct 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Please follow the guide below

What is the purpose of your pull request?

Description of your pull request and other information

Uh oh!

JarryShaw commented Oct 31, 2026

Uh oh!

JarryShaw commented Oct 31, 2026

Uh oh!

github-actions Bot commented Oct 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JarryShaw commented Oct 31, 2026

Uh oh!

JarryShaw commented Oct 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JarryShaw commented Oct 31, 2026

Uh oh!

JarryShaw commented Nov 1, 2026

Uh oh!

JarryShaw commented Nov 4, 2026

Uh oh!

JarryShaw commented Nov 4, 2026

Uh oh!

JarryShaw commented Nov 4, 2026

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

JarryShaw commented Oct 31, 2026 •

edited

Loading

github-actions Bot commented Oct 31, 2026 •

edited

Loading

JarryShaw commented Oct 31, 2026 •

edited

Loading