Repository navigation
docs(util): document that CITATION.cff dates a release by its version bump (#2163) - #2194
Conversation
|
Review: NEEDS CHANGES at |
dd6f8ac to
b59f77c
Compare
|
Review: GOOD TO GO at |
… 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.
|
Rebased onto
The patch changed in that docstring, so CI runs again and a delta check follows. |
b59f77c to
f9c96dd
Compare
|
Review: GOOD TO GO at |
|
Ready to merge at
|
make testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription
Closes #2163, per the owner's option D:
CITATION.cff'sdate-releasedis the date of the version-bump commit, not the date the release is distributed.util/bump_version.py's module docstring, itsRELEASED_KEYcomment andplan_citation'sreleasedargument 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 thereleasing.rstbullet say the same, the latter citing :issue:2163. With docstrings stripped,bump_version.py's AST is unchanged.CitationDateTests.test_a_bump_dates_the_release_by_the_bump_itselfintests/project/test_bump_version.pyrunsmain()and asserts thatversion,__version__and today's UTCdate-releasedmove together. It guards the ruled contract, so it passes onmaintoo. Makingmaindate the bump'2000-01-01'makes it fail.test_bump_version.py(33) and the project tests that read these files (349) pass.bump_version.pyparagraphs this PR removes, so they conflict. Whichever lands second takes this PR's wording.