CI

Author: apmoore1

.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: CI
+
+on:
+  workflow_dispatch: # Manually trigger a workflow run using the GitHub API, GitHub CLI, or the GitHub UI.
+  push:
+  pull_request:
+  release:
+    types: [published]
+
+permissions:
+  contents: read # required for code coverage
+  
+jobs:
+
+  checks:
+    name: checks
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        id: python-setup
+        with:
+          python-version: ${{ matrix.python-version }}
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        id: setup-uv
+        with:
+          # Install a specific version of uv.
+          version: "0.9.10"
+          enable-cache: true
+          restore-cache: true
+          save-cache: true
+          prune-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Install the project
+        run: uv sync --locked
+
+      - name: check uv cache is working
+        if: steps.setup-uv.outputs.cache-hit == 'true'
+        run: echo "uv cache was restored"
+
+      - name: isort
+        run: uv run isort --check-only src tests scripts
+      
+      - name: flake8
+        run: |
+          uv run flake8 --config .flake8 src tests scripts
+
+      - name: Cache mypy
+        uses: actions/cache@v4
+        with:
+          path: ./.mypy_cache
+          key: ${{ runner.os }}-${{ steps.python-setup.outputs.python-version }}-${{ hashFiles('uv.lock') }}
+
+      - name: mypy
+        run: uv run mypy
+
+      - name: Code coverage testing
+        run: |
+          uv run coverage run
+
+      - name: Code coverage report
+        run: |    
+          uv run coverage
+