Merge pull request #185 from ImperialCollegeLondon/add-semantic-versi…

…oning

Add semantic versioning

.github/workflows/publish-to-testpypi.yml

@@ -1,8 +1,7 @@
 name: "Publish to TestPyPI"
 
 on:
-  pull_request:
-    types: [opened, synchronize, reopened, ready_for_review]
+  push:
     branches:
       - main
   workflow_dispatch:
@@ -13,14 +12,19 @@ jobs:
 
     permissions:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
+      contents: write    # for git operations
 
     environment:
       name: testpypi
       url: https://test.pypi.org/p/PyProBE-Data
 
     steps:
       - uses: actions/checkout@v4
-
+        with:
+          fetch-depth: 0  # Fetch all history
+          fetch-tags: true  # Fetch all tags
+          ref: ${{ github.head_ref || github.ref_name }}  # Correct branch reference
+
       - name: Install uv
         uses: astral-sh/setup-uv@v5
 
@@ -32,6 +36,29 @@ jobs:
       - name: Install the project
         run: uv sync --all-extras --group format --group test --group docs --group external-integration
 
+      - name: Run semantic-release
+        id: semrel
+        run: |
+          uv run semantic-release version \
+            --prerelease \
+            --no-commit \
+            --no-tag \
+            --skip-build
+
+      - name: Update uv lockfile
+        run:  uv lock --upgrade-package pyprobe-data
+
+      - name: Get version
+        id: version
+        run: |
+          VERSION=$(grep -o '".*"' pyprobe/_version.py | sed 's/"//g')
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: Update version [skip ci]
+          tagging_message: "v${{ steps.version.outputs.version }}"
+
       - name: Build
         run: uv build
 

pyprobe/__init__.py

@@ -1,5 +1,6 @@
 """The PyProBE package."""
-from .cell import Cell, __version__, load_archive, make_cell_list  # noqa: F401
+from ._version import __version__  # noqa: F401
+from .cell import Cell, load_archive, make_cell_list  # noqa: F401
 from .dashboard import launch_dashboard  # noqa: F401
 from .logger import configure_logging  # noqa: F401
 from .plot import Plot  # noqa: F401

pyprobe/_version.py

@@ -0,0 +1 @@
+__version__ = "1.1.4"

pyprobe/cell.py

@@ -12,15 +12,14 @@
 import polars as pl
 from pydantic import BaseModel, Field, field_validator, validate_call
 
+from pyprobe._version import __version__
 from pyprobe.cyclers import arbin, basecycler, basytec, biologic, maccor, neware
 from pyprobe.filters import Procedure
 from pyprobe.readme_processor import process_readme
 from pyprobe.utils import PyBaMMSolution
 
 logger = logging.getLogger(__name__)
 
-__version__ = "1.1.0"
-
 
 class Cell(BaseModel):
     """A class for a cell in a battery experiment."""

pyproject.toml

@@ -3,7 +3,7 @@ name = "PyProBE-Data"
 authors = [
   {name = "Thomas Holland"},
 ]
-version = "1.1.0"
+dynamic = ["version"]
 requires-python = ">=3.11,<3.13"
 license = { file = "LICENSE" }
 dependencies = [
@@ -33,6 +33,7 @@ format = [
     "isort>=5.13.2",
     "mypy>=1.14.1",
     "pre-commit>=4.0.1",
+    "python-semantic-release>=9.15.2",
 ]
 test = [
     "pytest>=8.3.4",
@@ -71,6 +72,24 @@ exclude = [
     "examples/*"
 ]
 
+[tool.hatch.version]
+path = "pyprobe/_version.py"
+
+[tool.semantic_release]
+version_source = "tag"
+version_variables = ["pyprobe/_version.py:__version__"]
+changelog_file = false
+branch = "main" 
+commit_version_number = false  # disable auto commits
+tag_commit = false            # disable auto tagging
+prerelease = true
+upload_to_pypi = false        # disable PyPI upload
+upload_to_release = false     # disable GitHub release creation
+
+[tool.semantic_release.branches.main]
+match = "main"
+prerelease = true
+
 [tool.mypy]
 disallow_any_explicit = false
 disallow_any_generics = true

tests/test_cell.py

@@ -7,11 +7,11 @@
 import polars as pl
 import pybamm
 import pytest
-import toml
 from numpy.testing import assert_array_equal
 from polars.testing import assert_frame_equal
 
 import pyprobe
+from pyprobe._version import __version__
 from pyprobe.cell import Cell
 
 
@@ -332,14 +332,12 @@ def test_archive(cell_instance):
     metadata["PyProBE Version"] = "0.0.0"
     with open(os.path.join(input_path, "archive", "metadata.json"), "w") as f:
         json.dump(metadata, f)
-    pyproject_path = os.path.join(os.path.dirname(__file__), "..", "pyproject.toml")
-    pyproject_data = toml.load(pyproject_path)
     with pytest.warns(
         UserWarning,
         match=(
             f"The PyProBE version used to archive the cell was "
             f"{metadata['PyProBE Version']}, the current version is "
-            f"{pyproject_data['project']['version']}. There may be compatibility"
+            f"{__version__}. There may be compatibility"
             f" issues."
         ),
     ):