Switch to hatch-vcs for versioning (#4802)

* implement hatch-vcs versioning

* integrate hatch-vcs for automated versioning

- 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

* remove manual version update

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

* update release workflow for hatch-vcs

* Update version.py to use _version.py and conf.py to use importlib.metadata

* Revert update_version.py and use hatch-vcs in version.py

* Enable fetch-tags for hatch-vcs

* Minor updates to versioning and release workflow.

---------

Co-authored-by: Eric G. Kratz <[email protected]>
Co-authored-by: Saransh Chopra <[email protected]>

Author: 3 people

.github/release_workflow.md

@@ -9,10 +9,7 @@ GitHub, PyPI, and conda-forge by the maintainers.
    and September, updating incrementing the version to `vYY.MM.0` by running
    `scripts/update_version.py` in the following files:
 
-   - `pybamm/version.py`
-   - `docs/conf.py`
    - `CITATION.cff`
-   - `pyproject.toml`
    - `CHANGELOG.md`
 
    These changes will be automatically pushed to a new branch `vYY.MM`
@@ -34,13 +31,9 @@ If a new release is required after the release of `vYY.MM.{x-1}` -
    merged into `develop`. The CHANGELOG entry for such fixes should go under the
    `YY.MM.x` heading in `CHANGELOG.md`
 
-3. Run `scripts/update_version.py` manually while setting `VERSION=vYY.MM.x`
-   in your environment. This will update the version in the following files:
+3. Run `scripts/update_version.py` manually to update:
 
-   - `pybamm/version.py`
-   - `docs/conf.py`
    - `CITATION.cff`
-   - `pyproject.toml`
    - `CHANGELOG.md`
 
    Commit the changes to your release branch.

.github/workflows/publish_pypi.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          persist-credentials: false
+          persist-credentials: true
       - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
         with:
           python-version: 3.12

.gitignore

@@ -30,6 +30,9 @@
 *.cache
 .ipynb_checkpoints/
 
+# Version file (auto-generated by hatch-vcs)
+src/pybamm/_version.py
+
 # Sphinx build files
 docs/_build/
 docs/build/

docs/conf.py

@@ -14,6 +14,7 @@
 import os
 import sys
 import pybamm
+import importlib.metadata
 
 # Path for repository root
 sys.path.insert(0, os.path.abspath("../"))
@@ -29,7 +30,7 @@
 author = "The PyBaMM Team"
 
 # The short X.Y version
-version = pybamm.__version__
+version = importlib.metadata.version("pybamm")
 # The full version, including alpha/beta/rc tags
 release = version
 

pyproject.toml

@@ -1,12 +1,13 @@
 [build-system]
 requires = [
     "hatchling>=1.13.0",
+    "hatch-vcs>=0.3.0",
 ]
 build-backend = "hatchling.build"
 
 [project]
 name = "pybamm"
-version = "25.1.1"
+dynamic = ["version"]
 license = { file = "LICENSE.txt" }
 description = "Python Battery Mathematical Modelling"
 authors = [{name = "The PyBaMM Team", email = "[email protected]"}]
@@ -149,10 +150,12 @@ MSMR_Example = "pybamm.input.parameters.lithium_ion.MSMR_example_set:get_paramet
 Chayambuka2022 = "pybamm.input.parameters.sodium_ion.Chayambuka2022:get_parameter_values"
 
 [tool.hatch]
+version.source = "vcs"
 build.targets.sdist.include = [
   "src/pybamm",
   "CITATION.cff",
 ]
+build.hooks.vcs.version-file = "src/pybamm/_version.py"
 
 [tool.repo-review]
 ignore = [

scripts/update_version.py

@@ -1,42 +1,20 @@
 """
-Automatically update the version number
+Automatically update version numbers in various files for releases
 """
 
 import os
 import re
 from datetime import date
 import pybamm
+from pybamm._version import __version__ as release_version
 
 
 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:]
     release_date = date.today()
 
-    # pybamm/version.py
-    with open(
-        os.path.join(pybamm.root_dir(), "src", "pybamm", "version.py"), "r+"
-    ) as file:
-        output = file.read()
-        replace_version = re.sub(
-            '(?<=__version__ = ")(.+)(?=")', release_version, output
-        )
-        file.truncate(0)
-        file.seek(0)
-        file.write(replace_version)
-
-    # pyproject.toml
-    with open(os.path.join(pybamm.root_dir(), "pyproject.toml"), "r+") as file:
-        output = file.read()
-        replace_version = re.sub(
-            r'(?<=\bversion = ")(.+)(?=")', release_version, output
-        )
-        file.truncate(0)
-        file.seek(0)
-        file.write(replace_version)
-
     # CITATION.cff
     with open(os.path.join(pybamm.root_dir(), "CITATION.cff"), "r+") as file:
         output = file.read()
@@ -45,10 +23,10 @@ def update_version():
         file.seek(0)
         file.write(replace_version)
 
+    # CHANGELOG.md
     changelog_line1 = "# [Unreleased](https://github.com/pybamm-team/PyBaMM/)\n"
     changelog_line2 = f"# [v{release_version}](https://github.com/pybamm-team/PyBaMM/tree/v{release_version}) - {release_date}\n\n"
 
-    # CHANGELOG.md
     with open(os.path.join(pybamm.root_dir(), "CHANGELOG.md"), "r+") as file:
         output_list = file.readlines()
         output_list[0] = changelog_line1

src/pybamm/version.py

@@ -1 +1 @@
-__version__ = "25.1.1"
+from pybamm._version import version as __version__  # noqa: F401