Switch to hatch-vcs for versioning #4802

vidipsingh · 2025-01-26T17:07:50Z

Description

This PR implements hatch-vcs for versioning, enabling automatic versioning based on Git tags.

Related to: #4742

Type of change

New feature (non-breaking change which adds functionality)
Optimization (back-end change that speeds up the code)
Bug fix (non-breaking change which fixes an issue)

Key checklist:

No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
All tests pass: $ python -m pytest (or $ nox -s tests)
The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

Code is commented, particularly in hard-to-understand areas
Tests added that prove fix is effective or that feature works

codecov · 2025-01-26T17:59:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.69%. Comparing base (c017be4) to head (6eff861).
Report is 4 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #4802   +/-   ##
========================================
  Coverage    98.69%   98.69%           
========================================
  Files          303      303           
  Lines        23258    23258           
========================================
  Hits         22955    22955           
  Misses         303      303

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

kratman

Look at the "update_version.py" script in PyBaMM. A bunch of files are updated. For this to work you also need to get the other updated files working for releases.

Files like the change log will still need to be update for each release

vidipsingh · 2025-01-27T17:11:33Z

Look at the "update_version.py" script in PyBaMM. A bunch of files are updated. For this to work you also need to get the other updated files working for releases.

Files like the change log will still need to be update for each release

Thanks for the heads-up, @kratman! I'll look into the update_version.py script and other relevant files to ensure everything works properly for releases.

Saransh-cpp · 2025-01-27T22:22:36Z

pyproject.toml

+[tool.hatch.version]
+source = "vcs"


Can we move this down to the already existing tool.hatch section?

Suggested change

[tool.hatch.version]

source = "vcs"

[tool.hatch]

version.source = "vcs"

build.hooks.vcs.version-file = "src/pybamm/_version.py"

Sure, I'll move it to the tool.hatch section.

- Move hatch-vcs config to `tool.hatch` in `pyproject.toml` - Switch to `_version.py` for versioning with hatch-vcs - Remove manual `version.py` updates, using git tags instead

Saransh-cpp

@vidipsingh let us know when this is ready to review (by marking it as ready to review/un-draft).

agriyakhetarpal · 2025-02-06T13:16:24Z

scripts/update_version.py

+    version_file_path = os.path.join(pybamm.root_dir(), "src", "pybamm", "_version.py")
+    with open(version_file_path, "w") as f:
+        f.write(f'__version__ = "{release_version}"\n')
+


I don't think writing to this file is the right idea, as the file is supposed to be ignored in version control – hatch-vcs infers the version from the Git tag.

Was about to write that but I am guessing it is not ready for a review yet (the PR will require revamping the release workflow too)

Yup, just a bit of pre-emptive feedback so that @vidipsingh's work can proceed in the right direction :)

Was about to write that but I am guessing it is not ready for a review yet (the PR will require revamping the release workflow too)

@Saransh-cpp Could you please guide me on how to proceed with revamping the release workflow? Specifically, which files should I focus on to make the necessary changes?

vidipsingh · 2025-02-07T14:24:45Z

@vidipsingh let us know when this is ready to review (by marking it as ready to review/un-draft).

Sure, will do that.

- Removed manual version writing in `update_version.py`. - Added `src/pybamm/_version.py` to `.gitignore`.

kratman · 2025-02-18T00:04:20Z

scripts/update_version.py

@@ -10,33 +10,11 @@

 def update_version():
    """
-    Opens file and updates the version number
+    Updates version numbers and release information across project files
    """
    release_version = os.getenv("VERSION")[1:]


To make this work, you need to get the VCS version to set this environment variable

kratman · 2025-02-18T00:05:52Z

pyproject.toml

 build.targets.sdist.include = [
  "src/pybamm",
  "CITATION.cff",
 ]
+build.hooks.vcs.version-file = "src/pybamm/_version.py"


I would still make this src/pybamm/version.py so it is consistent with the previous file

Ok, then I will make it like this.

version.py and _version.py would be two different things. _version.py is generated by setuptools scm and should not be tracked in version control. version.py will simply import __version__ from _version.py to ensure backward compatibility. TLDR; this should be _version.py.

Got it, thanks for the clarification! I'll keep it as _version.py then.

vidipsingh · 2025-02-25T19:48:41Z

@kratman @Saransh-cpp @agriyakhetarpal Could you please advise on the next steps for this PR?
How should I proceed with the implementation, and what changes should be made to ensure this PR is ready to be merged?

kratman · 2025-02-25T20:08:20Z

@kratman @Saransh-cpp @agriyakhetarpal Could you please advise on the next steps for this PR? How should I proceed with the implementation, and what changes should be made to ensure this PR is ready to be merged?

The release workflow is described here: release_workflow.md

Since the version is now taken from VCS, you would need to make sure the update_version.py file correctly updates the files described in there. That script also uses an environment variable, so the script should be fixed so that it no longer needs that variable. Any way you get it working, the markdown file needs to be updated. You should also confirm that making a wheel gives the correct version based on a tag.

implement hatch-vcs versioning

d79a588

vidipsingh requested review from martinjrobins, Saransh-cpp, agriyakhetarpal, kratman and arjxn-py as code owners January 26, 2025 17:07

kratman requested changes Jan 26, 2025

View reviewed changes

Saransh-cpp marked this pull request as draft January 26, 2025 23:24

Merge branch 'develop' into implement-hatch-vcs-versioning

3ba901f

Saransh-cpp requested changes Jan 27, 2025

View reviewed changes

vidipsingh added 2 commits February 3, 2025 13:35

Merge branch 'develop' into implement-hatch-vcs-versioning

28c871d

integrate hatch-vcs for automated versioning

6eff861

- Move hatch-vcs config to `tool.hatch` in `pyproject.toml` - Switch to `_version.py` for versioning with hatch-vcs - Remove manual `version.py` updates, using git tags instead

Saransh-cpp reviewed Feb 6, 2025

View reviewed changes

agriyakhetarpal reviewed Feb 6, 2025

View reviewed changes

vidipsingh added 2 commits February 15, 2025 22:59

Merge branch 'develop' into implement-hatch-vcs-versioning

0f3ae91

remove manual version update

f0137f1

- Removed manual version writing in `update_version.py`. - Added `src/pybamm/_version.py` to `.gitignore`.

aabills mentioned this pull request Feb 16, 2025

Deprecate number of electrodes in parallel parameter #4854

Open

kratman reviewed Feb 18, 2025

View reviewed changes

Merge branch 'develop' into implement-hatch-vcs-versioning

55ec6d5

vidipsingh added 2 commits March 3, 2025 16:23

Merge branch 'develop' into implement-hatch-vcs-versioning

94a9bc5

update release workflow for hatch-vcs

9e1829e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch to hatch-vcs for versioning #4802

Switch to hatch-vcs for versioning #4802

vidipsingh commented Jan 26, 2025

codecov bot commented Jan 26, 2025 •

edited

Loading

kratman left a comment

vidipsingh commented Jan 27, 2025

Saransh-cpp Jan 27, 2025

vidipsingh Jan 28, 2025

Saransh-cpp left a comment

agriyakhetarpal Feb 6, 2025

Saransh-cpp Feb 6, 2025

agriyakhetarpal Feb 6, 2025

vidipsingh Feb 25, 2025

vidipsingh commented Feb 7, 2025

kratman Feb 18, 2025

kratman Feb 18, 2025

vidipsingh Feb 18, 2025

Saransh-cpp Feb 18, 2025

vidipsingh Feb 18, 2025

vidipsingh commented Feb 25, 2025

kratman commented Feb 25, 2025 •

edited

Loading

Switch to hatch-vcs for versioning #4802

Are you sure you want to change the base?

Switch to hatch-vcs for versioning #4802

Conversation

vidipsingh commented Jan 26, 2025

Description

Type of change

Key checklist:

Further checks:

codecov bot commented Jan 26, 2025 • edited Loading

Codecov Report

kratman left a comment

Choose a reason for hiding this comment

vidipsingh commented Jan 27, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Saransh-cpp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vidipsingh commented Feb 7, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vidipsingh commented Feb 25, 2025

kratman commented Feb 25, 2025 • edited Loading

codecov bot commented Jan 26, 2025 •

edited

Loading

kratman commented Feb 25, 2025 •

edited

Loading