♻️ (ci): refactor workflow to use Makefile, add caching and artifacts

🔧 (gitignore): add ignores for .hitm and Claude Code settings

♻️ (src,tests): apply black formatting for consistent docstring spacing

The CI workflow is restructured to integrate Makefile targets for streamlined linting, typing, and testing across Python versions, with added concurrency for efficiency, pip/mypy/ruff caching to speed up runs, and artifact uploads for coverage HTML and JUnit XML to improve debugging and reporting. Gitignore updates exclude new tool directories and local settings to prevent accidental commits. Source and test files receive minor formatting fixes, including blank lines after docstrings and single-line subprocess calls, to align with black's style enforcement and maintain code consistency.

Author: elifarley

.github/workflows/test.yml

@@ -6,40 +6,103 @@ on:
   pull_request:
     branches: [main, develop]
 
+concurrency:
+  group: cedarmapper-ci-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+env:
+  # default make target used by the job; override at workflow dispatch or in job in PR comments
+  MAKE_TARGET: ci
+  # change this to run a different make target in the job: e.g. MAKE_TARGET=test
+  PIP_CACHE_DIR: ~/.cache/pip
+
 jobs:
-  test:
+  ci:
+    name: CI (Makefile-driven)
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: true
       matrix:
-        python-version: ["3.12", "3.13"]
+        python-version: [3.12, 3.13]
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          cache: "pip"
 
-      - name: Install dependencies
+      - name: Cache mypy/ruff caches
+        uses: actions/cache@v4
+        id: cache-mypy-ruff
+        with:
+          # include python version so caches are separate between interpreters
+          path: |
+            .mypy_cache
+            .ruff_cache
+            htmlcov
+          key: ${{ runner.os }}-mypy-ruff-${{ matrix.python-version }}-${{ hashFiles('**/pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-mypy-ruff-${{ matrix.python-version }}-
+            ${{ runner.os }}-mypy-ruff-
+
+      - name: Install build & dev dependencies
+        # Keep this step hermetic and simple: install editable package with dev extras
         run: |
-          python -m pip install --upgrade pip
-          pip install -e ".[dev]"
+          python -m pip install --upgrade pip setuptools wheel
+          # Use editable install so `make` targets that call python modules run against current source
+          python -m pip install -e ".[dev]"
+        # If your project needs additional build steps (e.g. C extensions) add them here.
 
-      - name: Lint with ruff
-        run: ruff check src/ tests/
+      - name: Show environment (quick debug)
+        run: |
+          python --version
+          pip --version
+          pip list --format=columns | sed -n '1,200p'
+          echo "Make target: ${MAKE_TARGET}"
 
-      - name: Format check with black
-        run: black --check src/ tests/
+      - name: Run formatting check (black --check)
+        # split steps so logs are clearer and failures pinpointed
+        run: |
+          set -eo pipefail
+          make format || true
+          # enforce check: black --check to ensure CI fails on unformatted code
+          black --check src tests
 
-      - name: Type check with mypy
-        run: mypy src/
+      - name: Run static checks & tests via Makefile
+        # Use MAKE_TARGET env to run the aggregate CI target from your Makefile
+        run: |
+          set -eo pipefail
+          # run the Makefile target (defaults to 'ci')
+          make ${MAKE_TARGET}
+        env:
+          MAKE_TARGET: ${{ env.MAKE_TARGET }}
 
-      - name: Test with pytest
-        run: pytest --cov
+      - name: Run tests again with explicit pytest xml for artifact (optional)
+        # Some repos emit junit xml for test reporting; optional but useful.
+        if: always()
+        run: |
+          set -eo pipefail
+          # create junit xml and coverage xml in addition to html (pytest.ini already requests coverage xml)
+          pytest -q --junitxml=reports/junit.xml || true
+        continue-on-error: false
+
+      - name: Upload coverage HTML (artifact)
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-html-${{ matrix.python-version }}
+          path: htmlcov
 
-      - name: Upload coverage
-        uses: codecov/codecov-action@v3
+      - name: Upload pytest junit xml (artifact)
+        if: always()
+        uses: actions/upload-artifact@v4
         with:
-          files: ./coverage.xml
-          fail_ci_if_error: false
+          name: pytest-junit-${{ matrix.python-version }}
+          path: reports/junit.xml

.gitignore

@@ -129,3 +129,9 @@ dmypy.json
 *.swo
 *~
 .DS_Store
+
+# .HitM
+.hitm/
+
+# Claude Code
+.claude/settings.local.json

src/cedarmapper/core/analyzer.py

@@ -1,4 +1,5 @@
 """File analysis: binary detection, word counting, and metadata."""
+
 from __future__ import annotations
 
 import os
@@ -42,9 +43,7 @@ def count_words_with_wc(path: Path) -> Optional[int]:
         return None
     try:
         # Use wc -w filename
-        res = subprocess.run(
-            ["wc", "-w", str(path)], capture_output=True, text=True, check=False
-        )
+        res = subprocess.run(["wc", "-w", str(path)], capture_output=True, text=True, check=False)
         if res.returncode != 0:
             return None
         # output like: "<words> <filename>"

src/cedarmapper/core/model.py

@@ -1,4 +1,5 @@
 """Data models for file and directory information."""
+
 from __future__ import annotations
 
 from dataclasses import dataclass, field

src/cedarmapper/core/walker.py

@@ -1,4 +1,5 @@
 """Directory traversal and aggregation."""
+
 from __future__ import annotations
 
 from datetime import datetime

tests/test_analyzer.py

@@ -1,4 +1,5 @@
 """Tests for file analysis module."""
+
 import tempfile
 from pathlib import Path
 

tests/test_walker.py

@@ -1,4 +1,5 @@
 """Tests for directory traversal module."""
+
 import tempfile
 from pathlib import Path