Add basic CI

Author: liammulh

.github/actions/install-dependencies/action.yml

@@ -0,0 +1,10 @@
+name: "Install the dependencies for the HCI project"
+description: "Install uv, and then use uv to install Python dependencies for the project"
+runs:
+  using: "composite"
+  steps:
+    - name: "Install uv"
+      uses: "astral-sh/setup-uv@v5"
+    - name: "Install Python dependencies"
+      shell: bash
+      run: "uv sync"

.github/workflows/ci.yml

@@ -0,0 +1,65 @@
+name: "CI"
+on:
+  pull_request:
+    branches:
+      - "reorg"
+  push:
+    branches:
+      - "reorg"
+jobs:
+  format:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "./.github/actions/install-dependencies"
+      - name: "Make sure the code is properly formatted"
+        working-directory: ./src
+        run: "uv run ruff format --check"
+  lint:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "./.github/actions/install-dependencies"
+      - name: "Make sure the code is free of lint errors"
+        working-directory: ./src
+        run: "uv run ruff check"
+  type:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "./.github/actions/install-dependencies"
+      - name: "Run the type checker on the code"
+        working-directory: ./src
+        run: "uv run mypy ."
+  test:
+    runs-on: "ubuntu-latest"
+    env:
+      DJANGO_SECRET_KEY: "dummy"
+      DJANGO_SETTINGS_MODULE: "config.settings.dev"
+      PUBMED_API_KEY: "dummy"
+      PYTHONUNBUFFERED: "1"
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "./.github/actions/install-dependencies"
+      - name: "Run tests"
+        working-directory: ./src
+        run: "uv run pytest"
+  build_docs:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "./.github/actions/install-dependencies"
+      - name: "Build the developer documentation site"
+        working-directory: ./docs
+        run: "uv run make html"
+  build_coverage:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "./.github/actions/install-dependencies"
+      - name: "Collect test coverage stats"
+        working-directory: ./src
+        run: "uv run coverage -m pytest"
+      - name: "Build the test coverage report"
+        working-directory: ./src
+        run: "uv run coverage html"

TODO.md

@@ -114,6 +114,8 @@
     - [ ] The code transforms the underscore into a colon.
 - [ ] There is an include for help text
     - [ ] All help texts use this include.
+- [ ] The public recipes in the justfile use the private recipes.
+- [ ] All recipes in the justfile use `uv run`.
 
 ## The app test deployed to the test server and the prod server.
 
@@ -126,7 +128,9 @@
 - [ ] We have the following CI workflow: PR approved and merged → deploy to prod.
 - [ ] We have a footer in Ingrid's purple.
 - [ ] The help text can be edited by non-developers.
-- [ ] We have a Sphinx dev docs site.
-- [ ] We have the following CI workflow: PR opened → check dev docs site.
-- [ ] We have the following CI workflow: PR approved and merged → deploy dev docs.
+- [x] We have a Sphinx dev docs site.
+- [x] We have the following CI workflow: PR opened → check dev docs site.
+- [x] We have the following CI workflow: PR opened → check test coverage report.
+- [ ] We have the following CI workflow: PR approved and merged → deploy dev docs site.
+- [ ] We have the following CI workflow: PR approved and merged → test coverage report.
 - [ ] We've added Firebase.

docs/source/_static/.keep

@@ -24,114 +24,97 @@
 set dotenv-load := true
 
 #=======================================================================================
-# Aliases
+# Public Recipes
 #=======================================================================================
 
-alias f := fmt
-alias l := lint
-alias ty := type
-alias t := test
-alias tc := test-contract
-# TODO(Liam): Revert back to regular check once you're done fixing type check issues.
-alias cv := coverage
-alias do := docs
-alias c := temp-check
-alias d := dev
+# Run all code quality checks.
+check: format lint type _dj_check test coverage
 
-#=======================================================================================
-# Public Recipes
-#=======================================================================================
+# Show test coverage.
+coverage: _py_coverage
+
+# Run the development server.
+dev: _dj_makemigrations _dj_migrate _dj_runserver
+
+# Build the developer documentation site.
+docs: _sp_build_html
 
 # Format Python code.
-fmt: _py_fmt
+format: _py_format
 
 # Check Python code for common mistakes that can be identified by static analysis.
 lint: _py_lint
 
-# Check Python code for problems with type hints.
-type: _py_type
-
 # Run all tests.
-test: _dj_makemigrations _dj_migrate
-    cd src && coverage run -m pytest
-
-# Run contract tests.
-test-contract: _dj_makemigrations _dj_migrate
-    cd src && pytest -m contract
+test: _dj_makemigrations _dj_migrate _py_test
 
-# Show test coverage.
-coverage:
-    cd src && coverage report -m
-
-# Build the developer documentation site.
-docs:
-    cd docs && make html
-
-# Run all code quality checks.
-check: fmt lint type test _dj_check
-
-# TODO(Liam): Remove this once you're done fixing type check issues.
-# Run all code quality checks except type checking.
-temp-check: fmt lint test _dj_check
-
-# Run the development server.
-dev: _dj_makemigrations _dj_migrate
-    cd src && python manage.py runserver
+# Check Python code for problems with type hints.
+type: _py_type
 
 #=======================================================================================
 # Django Recipes
 #=======================================================================================
 
 # Use the system check framework to inspect the project for common problems.
 _dj_check:
-    cd src && python manage.py check
+    cd src && uv run manage.py check
 
 # Make migrations.
 _dj_makemigrations:
-    cd src && python manage.py makemigrations
+    cd src && uv run manage.py makemigrations
 
 # Apply migrations.
 _dj_migrate:
-    cd src && python manage.py migrate
+    cd src && uv run manage.py migrate
 
 # Run the development server.
 _dj_runserver:
-    cd src && python manage.py runserver
+    cd src && uv run manage.py runserver
 
 # Enter the shell.
 _dj_shell:
-    cd src && python manage.py shell
+    cd src && uv run manage.py shell
 
 #=======================================================================================
 # Python Code Quality Recipes
 #=======================================================================================
 
 # Format all files in the current directory and all subdirectories.
-_py_fmt:
-    uv run ruff format
+_py_format:
+    cd src && uv run ruff format
 
 # Check all files in the current directory and all subdirectories for formatting issues.
-_py_fmt_check:
-    uv run ruff format --check
+_py_format_check:
+    cd src && uv run ruff format --check
 
 # Lint all files in the current directory and all subdirectories.
 _py_lint:
-    uv run ruff check
+    cd src && uv run ruff check
 
 # Try to fix lint errors in current directory and all subdirectories.
 _py_lint_fix:
-    uv run ruff check --fix
+    cd src && uv run ruff check --fix
 
 # Check type hints in the `src` directory and all subdirectories.
 _py_type:
     cd src && uv run mypy .
 
+# Run test suite and collect coverage stats.
+_py_test:
+    cd src && uv run coverage run -m pytest
+
+# Report the test coverage stats.
+_py_coverage:
+    cd src && uv run coverage report
+
+# Build the test coverage report site.
+_py_build_coverage_html:
+    cd src && uv run coverage html
+
 #=======================================================================================
 # Sphinx Documentation Recipes
 #=======================================================================================
 
-_sp_build:
-    cd docs && make html
-
-_sp_run:
-    echo "Serving developer documentation: http://localhost:8001/html/index.html" && cd docs/build && python -m http.server 8001 --directory .
+# Build the developer documentation site.
+_sp_build_html:
+    cd docs && uv run make html