Skip to content

Complete bump-my-version integration: add automated version and date updates for CITATION.cff/codemeta.json - #1252

Merged
bact merged 5 commits into
devfrom
copilot/update-version-and-docs
Feb 1, 2026
Merged

Complete bump-my-version integration: add automated version and date updates for CITATION.cff/codemeta.json#1252
bact merged 5 commits into
devfrom
copilot/update-version-and-docs

Conversation

Copilot AI commented Feb 1, 2026

Copy link
Copy Markdown
Contributor

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:

  • CITATION.cff and codemeta.json were not configured in [tool.bumpversion], requiring manual version updates
  • Release dates in CITATION.cff (date-released) and codemeta.json (dateModified) had to be manually updated
  • release.md still documented manual version and date updates across files instead of using bump-my-version
  • CONTRIBUTING.md examples showed incorrect version increments (2.3.3 → 2.3.6-dev0 for patch, 2.3.3 → 2.3.1-dev0 for minor, and 2.3.1-dev1 after build bump)
  • build package missing from dev dependencies despite release.md requiring python -m build

How this fixes it

pyproject.toml:

  • Added CITATION.cff and codemeta.json to [[tool.bumpversion.files]] for automatic version updates
  • Added regex-based file entries to automatically update release dates using {now:%Y-%m-%d} context variable:
    • CITATION.cff: date-released field
    • codemeta.json: dateModified field
  • Added build>=1.0.0 to dev dependencies
  • Removed trailing space from bump-my-version version spec

release.md:

  • Replaced manual version update instructions with bump-my-version commands
  • Added command examples for all version parts (major/minor/patch/release/build)
  • Documented that 6 files are automatically updated (4 for versions, 2 for dates)
  • Removed manual date update step - now fully automated
  • Added prerequisites section with pip install -e ".[dev]"
  • Renumbered steps after removing manual date update step

CONTRIBUTING.md:

  • Fixed patch bump example: 2.3.3 → 2.3.4-dev0 (was 2.3.6-dev0)
  • Fixed minor bump example: 2.3.3 → 2.4.0-dev0 (was 2.3.1-dev0)
  • Fixed build bump example: 2.4.0-dev0 → 2.4.0-dev1 (was 2.3.1-dev1)

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

  • Passed code styles and structures
  • Passed code linting checks and unit test
Original prompt

we have partially worked on this issue of bump version: #1050

please continue to complete the task.

update all relevant documents. esp the release steps document.

check for consistency and validity. suggested command line should be all runnable, for example.

check if the tooling are updated.
we have migrate all configs to pyproject.toml with #1188 and maybe few other PRs, so it can be the case that something is outdated.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits February 1, 2026 21:24
…ase docs

Co-authored-by: bact <128572+bact@users.noreply.github.com>
Co-authored-by: bact <128572+bact@users.noreply.github.com>
Copilot AI changed the title [WIP] Update version and documentation for release process Complete bump-my-version integration: add CITATION.cff/codemeta.json support and update documentation Feb 1, 2026
Copilot AI requested a review from bact February 1, 2026 21:29
@bact bact added the documentation improve documentation and test cases label Feb 1, 2026
Comment thread release.md Outdated
Co-authored-by: bact <128572+bact@users.noreply.github.com>

Copilot AI commented Feb 1, 2026

Copy link
Copy Markdown
Contributor Author

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:

  • callowayproject.github.io
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title Complete bump-my-version integration: add CITATION.cff/codemeta.json support and update documentation Complete bump-my-version integration: add automated version and date updates for CITATION.cff/codemeta.json Feb 1, 2026
Copilot AI requested a review from bact February 1, 2026 21:43
@bact
bact requested a review from Copilot February 1, 2026 21:44

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.0 to 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)

Comment thread CONTRIBUTING.md Outdated
@bact

bact commented Feb 1, 2026

Copy link
Copy Markdown
Member

@copilot apply changes based on the comments in this thread

Co-authored-by: bact <128572+bact@users.noreply.github.com>
@sonarqubecloud

sonarqubecloud Bot commented Feb 1, 2026

Copy link
Copy Markdown

@bact
bact marked this pull request as ready for review February 1, 2026 21:56
@bact
bact merged commit 78d3ee4 into dev Feb 1, 2026
22 checks passed
@bact
bact deleted the copilot/update-version-and-docs branch February 1, 2026 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation improve documentation and test cases

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants