Skip to content

docs(util): document that CITATION.cff dates a release by its version bump (#2163) - #2194

Merged
JarryShaw merged 1 commit into
mainfrom
docs/2163-citation-date-is-the-bump
Oct 25, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/2163-citation-date-is-the-bump

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Closes #2163, per the owner's option D: CITATION.cff's date-released is the date of the version-bump commit, not the date the release is distributed.

  • Prose: util/bump_version.py's module docstring, its RELEASED_KEY comment and plan_citation's released argument now state that meaning. The "eventually anchoring both fields to create-release.yml" aspiration is removed, along with the residual-risk paragraph that treated the bump date as an approximation. CITATION.cff's header comment and the releasing.rst bullet say the same, the latter citing :issue:2163. With docstrings stripped, bump_version.py's AST is unchanged.
  • Test: CitationDateTests.test_a_bump_dates_the_release_by_the_bump_itself in tests/project/test_bump_version.py runs main() and asserts that version, __version__ and today's UTC date-released move together. It guards the ruled contract, so it passes on main too. Making main date the bump '2000-01-01' makes it fail.
  • Tests run: test_bump_version.py (33) and the project tests that read these files (349) pass.
  • Overlap: docs(repo): fifth whole-repo pass over the repository files (#1103) #2158 rewrites two of the bump_version.py paragraphs this PR removes, so they conflict. Whichever lands second takes this PR's wording.

@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) test Pull requests that add or correct tests (test: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Oct 25, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: NEEDS CHANGES at dd6f8ac64 (Sonnet): one paragraph in the module docstring, "So in this repository a bump is not a preparatory step…", still says the release follows "minutes later and with no human in between". That contradicts the new paragraph. The fix copies #2158's wording for that paragraph, so both PRs make the same change there. Everything else checked out: the AST is unchanged, the test passes, the mutation check fails as expected, and no text pins break.

@JarryShaw JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment review: running A cross-review is in flight against the current head - no verdict yet and removed review: running A cross-review is in flight against the current head - no verdict yet review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 25, 2026
@JarryShaw
JarryShaw force-pushed the docs/2163-citation-date-is-the-bump branch from dd6f8ac to b59f77c Compare October 25, 2026 14:09
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at b59f77c98 (Sonnet delta): range-diff shows only the copied #2158 paragraph changed, the docstring no longer contradicts itself, and test_bump_version.py plus the docstring contract pass.

@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 Oct 25, 2026
… bump (#2163)

Problem: util/bump_version.py's docstring and CITATION.cff's header framed
date-released as the publish date and the bump-time date as a gap, to be
closed by eventually moving both fields to create-release.yml.

Fix: per the owner's ruling, date-released is the date of the commit that
bumps the version, not the date the release is distributed. State that in
the module docstring, CITATION.cff's header and releasing.rst, and drop the
create-release.yml aspiration and the publish-date framing.

Test: test_a_bump_dates_the_release_by_the_bump_itself runs main() against
a scratch tree and pins that a bump writes the run's UTC date into
date-released alongside the new version.
@JarryShaw

Copy link
Copy Markdown
Owner Author

Rebased onto main after #2158 merged: b59f77c98 → f9c96dda3.

The patch changed in that docstring, so CI runs again and a delta check follows.

@JarryShaw
JarryShaw force-pushed the docs/2163-citation-date-is-the-bump branch from b59f77c to f9c96dd Compare October 25, 2026 14:20
@JarryShaw 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 Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at f9c96dda3 (Sonnet delta): the docstring agrees with itself after the rebase, the corrections #2158 made all survive, and test_bump_version.py plus the docstring contract pass.

@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 Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Ready to merge at f9c96dda3. Merging closes #2163.

@JarryShaw
JarryShaw merged commit 24d3e3d into main Oct 25, 2026
60 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 25, 2026
@JarryShaw
JarryShaw deleted the docs/2163-citation-date-is-the-bump branch October 25, 2026 17:46
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 25, 2026
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Pull requests that change documentation only (docs: subject prefix) test Pull requests that add or correct tests (test: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

fix(ci): CITATION.cff dates a release by its bump, not its approval

1 participant