Complete bump-my-version integration: add automated version and date updates for CITATION.cff/codemeta.json - #1252
Conversation
…ase docs Co-authored-by: bact <128572+bact@users.noreply.github.com>
Co-authored-by: bact <128572+bact@users.noreply.github.com>
Co-authored-by: bact <128572+bact@users.noreply.github.com>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Pull request overview
This PR completes the bump-my-version migration initiated in PR #1188 by automating version and date updates for CITATION.cff and codemeta.json metadata files, and rewriting release documentation with verified, runnable commands.
Changes:
- Configured bump-my-version to automatically update version numbers and release dates in CITATION.cff and codemeta.json using regex patterns and the
{now}context variable - Added
build>=1.0.0to dev dependencies and removed trailing whitespace from bump-my-version dependency - Rewrote release.md with comprehensive, runnable bump-my-version commands and restructured documentation for clarity
- Fixed incorrect version increment examples in CONTRIBUTING.md (patch and minor bumps)
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| pyproject.toml | Added 4 new file configuration entries for bump-my-version to handle CITATION.cff and codemeta.json version and date updates; added build package to dev dependencies; removed trailing space |
| release.md | Completely rewrote release process documentation with bump-my-version commands, added prerequisites section, documented automatic file updates, and removed manual date update steps |
| CONTRIBUTING.md | Fixed incorrect version numbers in bump examples (patch: 2.3.3→2.3.4-dev0, minor: 2.3.3→2.4.0-dev0) |
|
@copilot apply changes based on the comments in this thread |
Co-authored-by: bact <128572+bact@users.noreply.github.com>
|



What do these changes do
Completes the bump-my-version migration by configuring automatic updates for version numbers and release dates in CITATION.cff and codemeta.json, and rewriting the release documentation with verified, runnable commands.
What was wrong
After PR #1188 migrated to pyproject.toml and added bump-my-version to dev dependencies, critical gaps remained:
[tool.bumpversion], requiring manual version updatesdate-released) and codemeta.json (dateModified) had to be manually updatedbuildpackage missing from dev dependencies despite release.md requiringpython -m buildHow this fixes it
pyproject.toml:
[[tool.bumpversion.files]]for automatic version updates{now:%Y-%m-%d}context variable:CITATION.cff:date-releasedfieldcodemeta.json:dateModifiedfieldbuild>=1.0.0to dev dependenciesrelease.md:
pip install -e ".[dev]"CONTRIBUTING.md:
All commands validated as runnable. Version and date synchronization across all files (pyproject.toml, init.py, CITATION.cff, codemeta.json) now fully automated using bump-my-version's
{now}context variable.Your checklist for this pull request
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.