Merge pull request #56 from PalamaraLab/55-check-version-consistent

feat: check versioned files consistency (#55)

Author: alexallmont

.github/workflows/check-version.py

@@ -0,0 +1,37 @@
+"""
+Check that all files used in building project have consistent version number
+"""
+
+import re
+
+def _read_version_triplet(filename, regex):
+    with open(filename) as file:
+        for line in file:
+            regex = re.compile(regex)
+            match = re.search(regex, line)
+            if match:
+                major = int(match[1])
+                minor = int(match[2])
+                patch = int(match[3])
+                triplet = (major, minor, patch)
+                print(f" - {filename}: {triplet}")
+                return triplet
+
+    raise ValueError(f"Cannot find valid version triplet in {filename}")
+
+
+if __name__ == "__main__":
+    print("Checking project version files are consistent...")
+
+    cmake_version = _read_version_triplet("CMakeLists.txt", "project\(.* (\d+)\.(\d+)\.(\d+)\)")
+    docs_version = _read_version_triplet("docs/conf.py", "release.*v(\d+)\.(\d+)\.(\d+)")
+    pyproject_version = _read_version_triplet("pyproject.toml", "version.*\"(\d+)\.(\d+)\.(\d+)")
+
+    if cmake_version != docs_version:
+        raise ValueError(f"CMake/docs mismatch: {cmake_version}/{docs_version}")
+
+    if cmake_version != pyproject_version:
+        raise ValueError(f"CMake/pyproject mismatch: {cmake_version}/{pyproject_version}")
+
+    print(f"All versioned files match.")
+    print("Done!")

.github/workflows/qa-checks.yml

@@ -0,0 +1,27 @@
+name: "Code quality checks"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  qa-checks:
+    name: Python tests
+    runs-on: ubuntu-22.04
+    if:  ${{ github.event_name == 'pull_request' || github.repository == 'PalamaraLab/arg-needle-lib' }}
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.13
+
+      - name: Run version consistency check
+        run: |
+          python .github/workflows/check-version.py