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.08% -- tests failure, so this is partial (unit tier, Python 3.15, 7be441345, Unit Tests run failure)

Package	Statements	Missed	Branches	Partial	Cover
`pcapkit (top level)`	104	4	20	2	95.16%
`pcapkit/const`	20561	177	2832	158	98.53%
`pcapkit/corekit`	2697	74	854	37	96.65%
`pcapkit/dumpkit`	281	3	100	3	98.43%
`pcapkit/foundation`	3475	27	1206	32	98.74%
`pcapkit/interface`	138	4	52	3	96.32%
`pcapkit/protocols`	21416	218	5650	196	98.46%
`pcapkit/toolkit`	961	28	342	10	96.32%
`pcapkit/utilities`	512	7	144	5	98.17%
`pcapkit/vendor`	5256	2260	1198	194	53.61%

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

…6.0 (#2449) - Folded into the TLS/DTLS entry: the hello and EncryptedExtensions extension lists, their registered body decoders, register_tls_extension and the pcapkit.const.tls extension types (#2595), and each whole DTLS record in a datagram as a further layer (#2603). - The conventions entry records #2611's per-test purge rule; the member-order entry cites #2491. - No entry for #2595's private ProtocolBase value helpers, as for the other private API. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

JarryShaw · 2026-11-02T03:25:09Z

Fold-6 is pushed: 5ac9441be → ec47f7f55, a fast-forward that merges main at f9d5f0d1d.

feat(application): parse TLS handshake extensions #2595: the TLS/DTLS Added entry lists the decoded extensions and register_tls_extension, and cites feat(application): parse TLS handshake extensions #2514. It does not mention the private ProtocolBase helpers, following the precedent for private names.
feat(application): dissect every whole DTLS record in a datagram #2603: the same entry records the chaining of every whole DTLS record in a datagram, citing feat(application): dissect every DTLS record in a datagram, not only the first #2535.
test: import pcapkit once per class in TCPHTTPDispatchTests #2611: the conventions entry records the purge-in-setUp test rule, citing test: TCPHTTPDispatchTests purges pcapkit before every test, and test-coverage.rst records no per-test exception #2562.
refactor(protocols): order application protocol members #2491: added to the member-order entry's citations. It merged as 487c91c67 and is in no release.

…nto 1.6.0 (#2449) - Added: IEEE802_11, the 802.11 MAC header behind radiotap, with the pcapkit.const.ieee802_11 type and subtype registries (#2607); the Radiotap entry drops its stale "no dissector yet" note and names its own registry and register_radiotap. - Added: ip_datagram and tcp_datagram beside dtls_handshake (#2619). - The conventions entry records #2607's ruling on a paywalled registry's pinned secondary source. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

JarryShaw · 2026-11-02T04:06:25Z

Fold-7 is pushed: ec47f7f55 → 34f32f4f7, a fast-forward that merges main at 240451f09.

feat(link): dissect the IEEE 802.11 MAC header behind radiotap #2607: the Radiotap entry says the 802.11 frame is dissected. There is a new Added entry for IEEE802_11 and pcapkit.const.ieee802_11. The conventions entry records the pinned-secondary-source DATA rule (feat(link): dissect the 802.11 MAC header behind radiotap, with the frame body kept Raw #2575).
refactor(analysis): give IP and TCP reassembly their own foundation.analysis modules #2619: a new Added entry for ip_datagram/tcp_datagram, beside dtls_handshake.
docs(pep): stale status lines and a redundant Mermaid chain in pep.rst #2564: no entry, since it only corrects pep.rst's status lines.

… kinds into 1.6.0 (#2449) - Added: pad_length and PaddingField's align/after form (#2624), and pcapkit.utilities.contextvars (#2623); the old private names get no entry, as for the other private API. - Changed: the weekly Issue and PR Kinds workflow, beside the milestone workflow's entry (#2626). - The conventions entry records where a context variable lives (#2623), and the role-kind citation rule with its test (#2626). - No entry for #2626's heading and Mermaid fixes, #2564 or fa9af52. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

JarryShaw · 2026-11-02T04:41:48Z

Fold-8 is pushed: 34f32f4f7 → 52c6ec393, a fast-forward that merges main at fa9af520f.

refactor(corekit): add pad_length and PaddingField(align=, after=) #2624: a new Added entry for pad_length and PaddingField(align=, after=).
refactor(utilities): move the ContextVars shared across modules into pcapkit.utilities.contextvars #2623: a new Added entry for pcapkit.utilities.contextvars. The conventions entry records where a shared ContextVar lives.
docs: cite each number by its kind, and fix heading and Mermaid forms #2626: the conventions entry records the citation-kind rule and its test. A Changed entry covers the weekly Issue and PR Kinds workflow.
No entry for docs: cite each number by its kind, and fix heading and Mermaid forms #2626's heading and Mermaid fixes, for docs(pep): stale status lines and a redundant Mermaid chain in pep.rst #2564, or for the test-only fa9af520f.

JarryShaw · 2026-11-02T05:57:07Z

The red Python pypy3.11 leg here is not caused by this PR. Every Unit Tests run since #2595 fails it in the same way: three TLS extension rejections in test_tls_extension_quiet_rejection_2514_unit install tbtrim's excepthook on PyPy. That is tracked and being fixed in #2637. The changelog changes in this PR touch no code.

…types and the registry split into 1.6.0 (#2449) - Breaking: Quick-Start values their fields cannot carry raise, reversing 1.5.0's round-down of a TCP rate under 80 kbps (#2630). - Folded into unreleased entries: tls12_cid records and DTLSContext (#2631), LinkType 105 and 127 in Frame and PCAP-NG (#2632), and DTLS.analyze_handshake behind dtls_handshake and packet (#2634). - Changed: foundation.registry.protocols split into per-layer submodules (#2635); 1.6.0's register_* roles and 1.5.0's three register_protocol* roles point at their submodules, 1.5.0's text unchanged. - The conventions entry records the per-layer wrapper placement (#2635) and parse ownership (#2634). No entry for #2629, which changes no released behaviour. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

JarryShaw · 2026-11-02T05:59:07Z

Fold-9 is pushed: 52c6ec393 → 7be441345, a fast-forward that merges main at 0ba22703c.

fix(protocols)!: refuse Quick-Start values their fields cannot carry #2630: a breaking Changed entry. It lists the inputs that built in 1.5.x and now raise, and reverses 1.5.0's round-down (fix(tcp): Quick-Start Response reader reads a stray octet; maker fails below 40 kbps #1119).
feat(application): dissect RFC 9146 connection-ID DTLS records #2631: DTLS tls12_cid records, DTLSContext and extension 54, in the TLS/DTLS entry.
feat(link): bind LinkType 105 and 127 to the 802.11 and radiotap dissectors #2632: LinkType 105/127 clauses in the Radiotap and IEEE802_11 entries.
refactor(analysis): DTLS's foundation analysis wraps a DTLS protocol method #2634: the DTLS reassembly entry names DTLS.analyze_handshake.
refactor(registry): split foundation.registry.protocols by layer #2635: a Changed entry for the registry package split. The 13 registrar links in 1.6.0 are retargeted.
1.5.0.rst: the three register_protocol* links keep their text and resolve through titled roles.
Conventions entry: the layer rule and the parse-ownership rule.
No entry: refactor(protocols): range-check link and SSLv2 makers with _make_uint #2629 (a released-class message change only on unreleased classes) and the two test-only commits.

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 mentioned this pull request Nov 2, 2026

refactor(analysis): give IP and TCP reassembly their own foundation.analysis modules #2619

Merged

5 tasks done

JarryShaw added 2 commits November 1, 2026 23:01

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

c87a95d

JarryShaw added 2 commits November 1, 2026 23:36

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

04c4be7

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

140708f

This was referenced Nov 2, 2026

refactor(protocols)!: move NoPayload into misc/no_payload.py #2636

Open

fix(protocols): three TLS extension rejections are loud on PyPy, failing the required pypy3.11 leg #2637

Closed

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 21 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 2, 2026

Uh oh!

JarryShaw commented Nov 2, 2026

Uh oh!

JarryShaw commented Nov 2, 2026

Uh oh!

JarryShaw commented Nov 2, 2026

Uh oh!

JarryShaw commented Nov 2, 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 2, 2026

Uh oh!

JarryShaw commented Nov 2, 2026

Uh oh!

JarryShaw commented Nov 2, 2026

Uh oh!

JarryShaw commented Nov 2, 2026

Uh oh!

JarryShaw commented Nov 2, 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