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, ed294b4e6, 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`	2895	76	930	37	96.84%
`pcapkit/dumpkit`	286	3	102	3	98.45%
`pcapkit/foundation`	3507	27	1216	32	98.75%
`pcapkit/interface`	138	4	52	3	96.32%
`pcapkit/protocols`	22764	155	5918	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

JarryShaw · 2026-11-03T16:52:10Z

Folds 20 and 21 pushed: e331c1a8d → e915af74d. This includes merges of main at 07ceaf7c1 and at dea098b15.

Fold 20: fix(internet): build an MH CGA parameter from its data model or a schema without public_key_test (#2725) #2732, refactor!: hold mapping values in Info or Data, not dict subclasses (#2726) #2734 (breaking: FrameRecord and TLSKeyLog.entries), and fix(corekit): read a capture cut inside an option area as a short read (#2694) #2731, which an earlier fold had missed.
Fold 21: perf(const): import the const enum packages lazily (#2729) #2735, fix(dumpkit): dump a key renamed for clashing with a builtin under its own name (#2733) #2736, fix(internet)!: read a cut after an IPv6 option's type octet as a short read (#2727) #2737 (breaking: FieldValueError → ProtocolError), ci(experimental): give the GraalPy leg room to finish (#2739) #2741 and build(deps): bump sphinx-autodoc-typehints from 3.17.2 to 3.17.4 in /docs #2742. docs: clear the API docs build's Sphinx warnings (#2743) #2744 and docs: keep the colon off the first line of an attribute's documentation (#2745) #2746 are docs-only, so they get no entry.
Old values were measured on a v1.5.1 export. changelog_md.py --check and the changelog and doc-claim tests pass. The changelog pages build with no nitpicky warning.

#2735's entry names pcapkit.utilities.lazy as main has it today. A later fold renames it once #2748 merges.

- Fixed: a layer rebuilt by from_data reports its payload's messages once, where 1.5.x logged them twice, and IPv4 and the frame-end layers record a cut as their own short read (#2738), a new entry; old values measured against v1.5.1. - Folded into unreleased entries (#2738): a standalone IGMPv3 Report sized by its record count, into the IGMP entry; the recorded cuts' TRUNCATED status, TSO IPv4 and ICMPv4 included, into the checksum entry; ListField's count, into its zero-fill entry; the quiet rebuilt payload, into the conventions entry. - #2748: pcapkit.utilities.lazy becomes pcapkit.utilities.importlib in the lazy-import and conventions entries; the old name appears nowhere. - No entry for the direct-pushed 21ec0a6, which has no pull request or issue to cite. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

JarryShaw · 2026-11-03T20:14:23Z

Fold 22 pushed: e915af74d → fb64180eb, merging main at f45c82b5d. It adds a Fixed entry for #2738, folds #2738 into the IGMP, checksum, ListField and conventions entries, and renames utilities.lazy to utilities.importlib in the #2735 entry. changelog_md.py --check and the changelog tests pass, and the changelog pages build with no nitpicky warning.

The output of codemod-v2.py on 05e1137, with no hand edits. - protocols/<layer>/<proto>.py and its schema/ and data/ modules become protocols/<layer>/<proto>/{protocol,schema,data}.py; each package __init__ exports its class alone, eagerly. - The TLS record data models SSL reads move from tls/data.py to a new ssl/data.py, as pieces the family shares; tls/data.py keeps TLS. - The schema/ and data/ trees and their aggregations go, with no alias: schema/schema.py is protocols/schema.py, data/data.py and data/protocol.py merge into protocols/data.py, and ipv6_option merges into ipv6_ext.schema. - ProtocolBase.__init_subclass__ finds a class's schema and data in its own package and imports Raw's on demand. - Imports, ModuleDescriptor strings, docs targets, paths and test specs are rewritten; released changelogs get every role target, 1.6.0 stays with #2483. - versionremoved records every name v1.5.1 shipped that no longer resolves at its old path, read from the tag by a new util/shipped_names.py into a checked-in fixture; a re-export points at its defining module, and the address patterns #2614 removed unrecorded get their note too. - The 1744 test gains TestShippedNames, which fails on any such name left unrecorded; tests that walked or pinned the old trees follow the new layout, two that pinned only the aggregations are deleted, and a new test pins the layout. All modules import, protocol models are unchanged, every unittest leg and project guard passes, and a non-editable docs build is warning-free.

The output of codemod-v2.py on 05e1137, with no hand edits. - protocols/<layer>/<proto>.py and its schema/ and data/ modules become protocols/<layer>/<proto>/{protocol,schema,data}.py; each package __init__ exports its class alone, eagerly, and binds each public class its schema and data modules define as Schema_<name> and Data_<name>, outside __all__, in a block per role under a "# Header Schemas" or "# Data Models" heading whose isort: split keeps isort sorting each block in place, as ruled in review of #2753; protocol-family-grouping.rst shows the layout and the doc-claims test pins every __init__ to it. - The TLS record data models SSL reads move from tls/data.py to a new ssl/data.py, as pieces the family shares; tls/data.py keeps TLS. - The schema/ and data/ trees and their aggregations go, with no alias: schema/schema.py is protocols/schema.py, data/data.py and data/protocol.py merge into protocols/data.py, and ipv6_option merges into ipv6_ext.schema. - ProtocolBase.__init_subclass__ finds a class's schema and data in its own package and imports Raw's on demand. - Imports, ModuleDescriptor strings, docs targets, paths and test specs are rewritten; released changelogs get every role target, 1.6.0 stays with #2483. - versionremoved records every name v1.5.1 shipped that no longer resolves at its old path, read from the tag by a new util/shipped_names.py into a checked-in fixture; a re-export points at its defining module, and the address patterns #2614 removed unrecorded get their note too. - The 1744 test gains TestShippedNames, which fails on any such name left unrecorded; test_public_api leaves the ruled aliases out of its unlisted names; tests that walked or pinned the old trees follow the new layout, two that pinned only the aggregations are deleted, and a new test pins the layout and the aliases. All modules import, protocol models are unchanged, every unittest leg and project guard passes, and a non-editable docs build is warning-free.

The output of codemod-v2.py on 4f62f52, with no hand edits. - protocols/<layer>/<proto>.py and its schema/ and data/ modules become protocols/<layer>/<proto>/{protocol,schema,data}.py; each package __init__ exports its class alone, eagerly, and binds each public class its schema and data modules define as Schema_<name> and Data_<name>, outside __all__, in a block per role under a "# Header Schemas" or "# Data Models" heading, as ruled in review of #2753. A [tool.isort] section in pyproject.toml keeps isort off these files, filter_files included; protocol-family-grouping.rst shows the layout and the doc-claims test pins every __init__ to it. - The TLS record data models SSL reads move from tls/data.py to a new ssl/data.py, as pieces the family shares; tls/data.py keeps TLS. - The schema/ and data/ trees and their aggregations go, with no alias: schema/schema.py is protocols/schema.py, data/data.py and data/protocol.py merge into protocols/data.py, and ipv6_option merges into ipv6_ext.schema. - ProtocolBase.__init_subclass__ finds a class's schema and data in its own package and imports Raw's on demand. - Imports, ModuleDescriptor strings, docs targets, paths and test specs are rewritten; released changelogs get every role target, 1.6.0 stays with #2483. - versionremoved records every name v1.5.1 shipped that no longer resolves at its old path, read from the tag by a new util/shipped_names.py into a checked-in fixture; a re-export points at its defining module, and the address patterns #2614 removed unrecorded get their note too. - The 1744 test gains TestShippedNames, which fails on any such name left unrecorded; test_public_api leaves the ruled aliases out of its unlisted names; tests that walked or pinned the old trees follow the new layout, two that pinned only the aggregations are deleted, and a new test pins the layout and the aliases. All modules import, protocol models are unchanged, every unittest leg and project guard passes, and a non-editable docs build is warning-free.

… into one package (#2534) (#2753) The output of codemod-v2.py on 4f62f52, with no hand edits. - protocols/<layer>/<proto>.py and its schema/ and data/ modules become protocols/<layer>/<proto>/{protocol,schema,data}.py; each package __init__ exports its class alone, eagerly, and binds each public class its schema and data modules define as Schema_<name> and Data_<name>, outside __all__, in a block per role under a "# Header Schemas" or "# Data Models" heading, as ruled in review of #2753. A [tool.isort] section in pyproject.toml keeps isort off these files, filter_files included; protocol-family-grouping.rst shows the layout and the doc-claims test pins every __init__ to it. - The TLS record data models SSL reads move from tls/data.py to a new ssl/data.py, as pieces the family shares; tls/data.py keeps TLS. - The schema/ and data/ trees and their aggregations go, with no alias: schema/schema.py is protocols/schema.py, data/data.py and data/protocol.py merge into protocols/data.py, and ipv6_option merges into ipv6_ext.schema. - ProtocolBase.__init_subclass__ finds a class's schema and data in its own package and imports Raw's on demand. - Imports, ModuleDescriptor strings, docs targets, paths and test specs are rewritten; released changelogs get every role target, 1.6.0 stays with #2483. - versionremoved records every name v1.5.1 shipped that no longer resolves at its old path, read from the tag by a new util/shipped_names.py into a checked-in fixture; a re-export points at its defining module, and the address patterns #2614 removed unrecorded get their note too. - The 1744 test gains TestShippedNames, which fails on any such name left unrecorded; test_public_api leaves the ruled aliases out of its unlisted names; tests that walked or pinned the old trees follow the new layout, two that pinned only the aggregations are deleted, and a new test pins the layout and the aliases. All modules import, protocol models are unchanged, every unittest leg and project guard passes, and a non-editable docs build is warning-free.

# Conflicts: # docs/source/changelog/1.5.0.rst

- Breaking: each protocol is a package of protocol, schema and data modules, the pcapkit.protocols.schema and .data trees and their aggregate exports removed with no alias, and a 1.5.x data model pickle fails to load (#2753), a new entry with the 1.5.1 imports and pickle measured. - 1.6.0's pcapkit.protocols role targets point at the package modules; the aggregator export claims of unreleased entries, the NoPayload and FrameRecord pickle claims and the TLSKeyLogEntries alias follow the layout. - CI: the LATEST tier's own job and the Coverage merge (#2754) and the ordering leg's halved rest of tests/protocols (21ec0a6, #2751), into the CI-legs entry; the package ruling into the conventions entry. - No entry for the test-only #2752. - The merge keeps #2483's class names in 1.5.0's conflicting roles under #2753's package paths. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

JarryShaw · 2026-11-04T03:27:29Z

Fold 23 pushed: fb64180eb → 3bd890f28. It merges main at 1b4f9703e and resolves the 1.5.0.rst conflict, keeping the current class names under the new package paths.

New breaking entry for refactor(protocols)!: group each protocol's protocol, schema and data into one package (#2534) #2753: the package layout, the Schema_* / Data_* aliases that replace the aggregate names, and the base modules. It states plainly that a v1.5.1 data-model pickle no longer loads.
ci(unit-tests): run the LATEST tier in a job of its own under coverage (#2751) #2754 and the ordering split (ci(unit-tests): the Python 3.15 job's p90 is past half its cap (CI timing HARD H1) #2751) go into the CI-legs entry. test: release purged pcapkit generations in a long unittest leg (#2750) #2752 is test-only and gets no entry.
All pcapkit.protocols targets in 1.6.0 now point at the new layout. Claims the regrouping made false are removed: the never-released aggregate names, and the "pickles load both ways" lines.
changelog_md.py --check and the changelog tests pass, and both changelog pages build with no nitpicky warning.

JarryShaw · 2026-11-04T13:56:03Z

Holding this PR for one more fold. #2758 and #2759 merged before it, so their entries need adding, along with the one for #2755. Once #2757 merges, its entry goes in too, and then this PR is ready to merge, last.

- Fixed: a cut header's rebuild keeps the next layer its parse had, where 1.5.x rebuilt a cut Ethernet header's Raw as NoPayload, and that Raw carries no error (#2759), a new entry; old values measured against v1.5.1. - Amended unreleased entries (#2758): a cut list of schema items ends with the data, the item the cut lands inside zero-filled and none past it, in the ListField, IGMP and HTTP/2 SETTINGS entries, the last also rebuilding at its declared Length or a recomputed one once edited. - Folded (#2755): a counted item the data ends inside reads as a quiet short read, into the ListField and IGMP entries. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

- Folded into the lazy-import entry (#2757): pcapkit.protocols, its layer packages, misc.pcap, misc.checksum and pcapkit import their protocol classes on first use, pcapkit.protocols.registry builds __proto__ on first read, and dir(pcapkit) lists none of the incidental names 1.5.1 listed (os, sys, ROOT, warnings, tbtrim), measured on a v1.5.1 export; the ruling into the conventions entry. - No mention of foundation.registry.protocols.protocol_registry, an import alias 1.5.1 neither exported nor documented, nor of an import time. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.

JarryShaw · 2026-11-04T14:25:02Z

GOOD TO GO at ed294b4e6 (Sonnet cross-review of folds 24–25, and my own read of the diff)

Fold 24 covers fix(corekit): read a counted list's cut item as a short read, not a negative length (#2749) #2755, fix(corekit): end a cut list of schema items with the data, not in zero-filled items (#2756) #2758 and fix(protocols): rebuild a cut header with the next layer it parsed with (#2717) #2759. It amends the ListField, IGMP and HTTP/2 SETTINGS entries so that none of them says items fill the declared length, and it adds the cut-header Raw rebuild entry.
Fold 25 adds perf(protocols): import the packages above a protocol's on first use (#2730) #2757 to the lazy-import entry. The 1.5.1 dir(pcapkit) names it cites (ROOT, os, sys, tbtrim, warnings) match exactly.
Every claim was checked against the merged code, on both trees. No earlier entry contradicts these. changelog_md.py --check and the changelog-reading tests pass. Project tests, Lint and deploy-pages pass.
This is the last open PR, and it can merge.

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 2 commits November 3, 2026 15:03

Merge commit 'f45c82b5d' into fold22

2f0e0b2

This was referenced Nov 3, 2026

test: release purged pcapkit generations in a long unittest leg (#2750) #2752

Merged

refactor(protocols)!: group each protocol's protocol, schema and data into one package (#2534) #2753

Merged

JarryShaw mentioned this pull request Nov 3, 2026

ci(unit-tests): run the LATEST tier in a job of its own under coverage (#2751) #2754

Merged

5 tasks done

JarryShaw added 2 commits November 3, 2026 22:13

Merge commit '1b4f9703e' into fold23

21bcc8e

# Conflicts: # docs/source/changelog/1.5.0.rst

Merge commit '73f730757' into fold24

b853afe

JarryShaw mentioned this pull request Nov 4, 2026

Reorder protocol class members to the member-order convention #2490

Open

JarryShaw added 3 commits November 4, 2026 09:08

Merge commit 'c211805ae' into fold25

5b1a352

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: 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(application): rebuild an adopted SSLv2 or DTLS 1.3 record from its to_dict() (#2762) #2764

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 53 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 3, 2026

Uh oh!

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

Uh oh!

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