Repository navigation
chore(docs): centralise changelog entries for unreleased versions - #2483
Conversation
|
NEEDS CHANGES (Sonnet,
|
30953ed to
4f2af68
Compare
|
NEEDS CHANGES (Sonnet,
|
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
4f2af68 to
a9db8a4
Compare
|
Coverage: 94.46% (unit tier, Python 3.15,
Per-file detail: the |
|
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. |
|
Ruling reconciled: upon each release, amend |
|
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 |
- 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
- Added: pcapkit.utilities.inspect and its isabstract, which decides a class's abstractness from its namespace and its bases' __abstractmethods__ rather than the interpreter's abstract flag, and which Protocol's registration uses (#2785); the defect it fixes never shipped and is not described. - Prepared ahead of #2785 merging, so main is not merged in yet. - CHANGELOG.md regenerated; util/changelog_md.py --check passes.
|
Decision needed: how 1.6.0's release starts. Once this PR is in, the only release step left is the version, and
Recommendation: (a), because one merge means one release run and no second push to keep |
|
GOOD TO GO at |
|
take (a) is the pep update-to-update? closing wave2? dont forget to post updates to Discussion as well |
|
Reconciled: (a) taken. The 1.6.0 heading date and the hand edit to On the PEP page: I'm auditing its wave 2 section against what 1.6.0 shipped. Any update, including marking wave 2 closed, goes into this PR too, so it lands with the release. Discussion #106 (Enhancement Proposals) will get the wave 2 update. I'll report back here with the diff and a fresh verdict. |
|
The PEP page is not up to date. It marks wave 2 done (#2564), but:
I'm folding the fixes into this PR so they land with the release, along with Discussions: this repo has never posted release announcements. Progress has gone as replies under the matching #106 topic, so I'll post the wave 2 and reassembly updates there once the release publishes, when the links work. I'm posting the NGAP update on #251 now, since it has been true since 1.5.0. |
|
Owner ruling (in session, paraphrased): stop tracking waves. What is left is simply the remaining work, and the wave statements were internal decision tracking, so they come out entirely. Here is how I'm applying it in this PR:
Released changelogs (1.5.0) stay as shipped. The #106 updates will drop the wave wording too. |
- pep.rst: the shared-base pairs are recorded as done in 1.6.0, and the Release Plan gains a 1.6.0 entry. - pep.rst: status for the checksum split, IPv6 overlap, DCCP and GRE bindings, and the split TLS record gap. - SECURITY.md: 1.6.x is the current stable line. - New 1.6.0 modules gain a versionadded on their pages and in module docstrings that lacked one. - 1.6.0 intro: the Linux cooked-capture headers are counted among the shared-base pairs.
…0 notes (#2449) - pep.rst: the Delivery Sequence becomes Remaining Work, listing only open items and their prerequisites; done entries that tracked waves are gone. - pep.rst: the Release Plan subsections and status lines drop their wave labels; the ARPHRD bindings and the NULL/RAW note move to Registered, but Not Dissected. - 1.6.0 intro, changelog.rst summary and process.rst describe what ships and what remains, with no waves.
4b71a22 to
ff31e28
Compare
|
GOOD TO GO at Since
Two Sonnet cross-reviews per round, one on content and one on the ruling, checked the work against v1.5.0, v1.5.1 and the code. No roadmap wave is left, the force-pushed history keeps the old trees exactly, every dropped fact is either restated or still in the changelog, and the anchors resolve. The docs build in the pinned venv adds no warnings. The 1.5.0 changelog is left as released. |
|
The squash merge ( |
Please follow the guide below
make testpasses, and a test case covers the change (tests/project/test_pr_template_commit_types_1102_unit.pyandtests/project/test_python_versions_update_1660.pyrun)What is the purpose of your pull request?
chore— anything elseDescription of your pull request and other information
Closes #2449
Feature PRs no longer add entries under
docs/source/changelog/or toCHANGELOG.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.pyand its test follow the new box wording. No runtime code or release content changed.