Version 2.0

.githooks/post-commit

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+set -e
+
+# Detect if COMO.ipynb exists in non-pushed git history
+# If it does, clear its cell outputs before committing
+NOTEBOOK="main/COMO.ipynb"
+if git diff-tree --no-commit-id --name-only -r HEAD | grep -q "^$NOTEBOOK$"; then
+  jupyter-nbconvert --clear-output --inplace "$NOTEBOOK"
+
+  # re-commit if the notebook was changed
+  if ! git diff --quiet "$NOTEBOOK"; then
+    git add "$NOTEBOOK"
+    git commit -m "Clear outputs from jupyter notebook"
+  fi
+fi

.githooks/pre-commit

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+set -e
+
+# Run `ruff check` only on staged files
+files=$(git diff --cached --name-only --diff-filter=ACM | grep '\.py$')
+if [ -z "$files" ]; then
+  exit 0
+fi
+ruff check --no-fix "$files"
+status=$?
+if [ $status -ne 0 ]; then
+  echo "Ruff found issues. Commit aborted."
+  exit 1
+fi
+
+# If `ruff check` is good, then format all staged files
+ruff check --fix --select I "$files"
+ruff format "$files"
+
+
+exit 0

.github/dependabot.yml

@@ -2,6 +2,7 @@ version: 2
 updates:
   - package-ecosystem: "github-actions"
     directory: "/"
+    target-branch: "hotfix"
     schedule:
       # Check for updates to GitHub Actions every weekday
       interval: "daily"

.github/workflows/container_build.yml

@@ -11,8 +11,11 @@ env:
 
 jobs:
   build-and-push-image:
+    # IMPORTANT: Only run the publish job when a tag starting with 'v' is pushed
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+
     name: Build and Push Docker Image
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     permissions:
       contents: read
       packages: write

.github/workflows/continuous_integration.yml

@@ -7,62 +7,11 @@ on:
   workflow_dispatch:
 
 jobs:
-  format:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v5
-
-      - name: Create Virtual Environment
-        run: uv venv
-
-      - name: Install Jupyter
-        run: uv pip install jupyter nbconvert
-
-      - name: Strip Notebook Output
-        run: uv run jupyter nbconvert --clear-output --inplace "main/COMO.ipynb"
-
-      - name: Format Python Imports
-        uses: astral-sh/ruff-action@v3
-        with:
-          args: "check --fix --select I"
-
-      - name: Format code
-        uses: astral-sh/ruff-action@v3
-        with:
-          args: "format"
-
-      - name: Format Notebook
-        uses: astral-sh/ruff-action@v3
-        with:
-          args: "format main/COMO.ipynb"
-
-      - name: Commit Changes
-        uses: stefanzweifel/git-auto-commit-action@v5
-        with:
-          commit_message: "style: format code, Jupyter Notebook(s), and Python imports with `ruff`"
-          file_pattern: "main/como/*.py"
-
-
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Check Lint
-        uses: astral-sh/ruff-action@v3
-        with:
-          args: "check --no-fix --verbose"
-
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ "3.10" ]
+        python-version: [ "3.11", "3.12", "3.13" ]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -78,7 +27,7 @@ jobs:
         run: uv sync --python "${{ matrix.python-version }}" --all-extras --dev
 
       - name: Run tests
-        run: uv run --python "${{ matrix.python-version }}" pytest --cov --junitxml=junit.xml -o junit_family=legacy
+        run: uv run --python "${{ matrix.python-version }}" pytest
 
       - name: Cache Clear
         run: uv cache prune --ci

.github/workflows/pypackage_build.yml

@@ -0,0 +1,92 @@
+name: Build and publish python package
+
+on:
+  push:
+    tags:
+      - "*"
+
+# Define permissions needed for the workflow GITHUB_TOKEN
+permissions:
+  contents: read # Allow checkout
+  packages: write # Allow publishing to GitHub Packages
+
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        operating-system: [macos-latest, ubuntu-latest, windows-latest]
+        python-version: [ 3.10, 3.11, 3.12, 3.13 ]
+
+    name: Build Python Package (${{ matrix.operating-system }}, Python ${{ matrix.python-version }})
+    runs-on: ${{ matrix.operating-system }}
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Hatch
+        run: pip install hatch
+
+      - name: Build distributions
+        run: hatch build # Uses pyproject.toml to build sdist and wheel into dist/
+
+      - name: Upload distributions artifact
+        uses: actions/upload-artifact@v4 # Action to save artifacts between jobs
+        with:
+          name: como-distribution-package-${{ matrix.operating-system }}-${{ matrix.python-version }}  # Name for the artifact
+          path: dist/ # Path to the directory to upload
+
+  publish:
+    strategy:
+      matrix:
+        python-version: [ 3.10, 3.11, 3.12, 3.13 ]
+        operating-system: [macos-latest, windows-latest, ubuntu-latest]
+
+    name: Publish to GitHub Packages
+    runs-on: ubuntu-latest
+    needs: build # Depends on the build job succeeding
+
+    # IMPORTANT: Only run the publish job when a tag starting with 'v' is pushed
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+
+
+    permissions: # Explicit permissions needed for this job
+      packages: write # Required to write to GitHub Packages registry
+      contents: read # Needed if accessing repo content (e.g., for download artifact)
+
+    steps:
+      - name: Download distributions artifact
+        uses: actions/download-artifact@v4 # Action to retrieve artifacts from previous job.
+        with:
+          name: como-distribution-package-${{ matrix.operating-system }}-${{ matrix.python-version }}
+          path: dist/
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Twine
+        run: pip install twine
+
+      - name: Publish package to GitHub Packages
+        env:
+          # Use __token__ as username and the automatically generated GITHUB_TOKEN as password
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          echo "Uploading to GitHub Packages for repository: ${{ github.repository }}"
+          # Construct the repository URL dynamically using the repository owner
+          TWINE_REPOSITORY_URL="https://pypi.pkg.github.com/${{ github.repository_owner }}"
+          python -m twine upload --verbose --repository-url ${TWINE_REPOSITORY_URL} dist/*
+
+
+

.pre-commit-config.yaml

@@ -1,8 +1,6 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
 repos:
--   repo: https://github.com/opensource-nepal/commitlint
-    rev: v1.2.0
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: master
     hooks:
-    -   id: commitlint
-        name: Commit Lint
+      - id: commitizen
+        stages: [ commit-msg ]