Release 1.2.1

.github/workflows/behave.yml

@@ -0,0 +1,91 @@
+---
+name: Run behave
+
+on:
+  push:
+    branches:
+      - "**"
+  pull_request:
+    branches:
+      - main
+      - develop
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  behave:
+    name: Run Behave
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - name: Check out the code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker
+        uses: docker/setup-buildx-action@v3
+
+      - name: Install Docker Compose
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y docker-compose make
+
+      - name: Check Docker state (pre-build)
+        run: docker ps
+
+      - name: Build Docker images
+        run: make build
+        env:
+          PYTHON_IMAGE_VER: "${{ matrix.python-version }}"
+
+      - name: Migrate Database
+        run: make migrate
+
+      - name: Run Application
+        run: make run
+
+      - name: Check Docker state (pre-test)
+        run: docker ps
+
+      - name: Run pytest + behave with Coverage
+        env:
+          POSTGRES_USER: scram
+          POSTGRES_DB: test_scram
+        run: make coverage.xml
+
+      - name: Dump docker logs on failure
+        if: failure()
+        uses: jwalton/gh-docker-logs@v2
+
+      - name: Upload Coverage to Coveralls
+        if: matrix.python-version == '3.12'
+        uses: coverallsapp/github-action@v2
+
+      - name: Upload Coverage to GitHub
+        if: matrix.python-version == '3.12'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage.xml
+
+      - name: Display Coverage Metrics
+        if: matrix.python-version == '3.12'
+        uses: 5monkeys/cobertura-action@v14
+        with:
+          minimum_coverage: "50"
+
+      - name: Check Docker state (post-test)
+        if: always()
+        run: docker ps
+
+      - name: Stop Services
+        if: always()
+        run: make stop
+
+      - name: Clean Up
+        if: always()
+        run: make clean

.github/workflows/behave_next_python.yml

@@ -0,0 +1,77 @@
+---
+name: Run behave with unsupported Python versions
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - main
+      - develop
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  behave_next_python:
+    name: Run Behave
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: ['3.13']
+
+    steps:
+      - name: Check out the code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker
+        uses: docker/setup-buildx-action@v3
+
+      - name: Install Docker Compose
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y docker-compose make
+
+      - name: Check Docker state (pre-build)
+        run: docker ps
+
+      - name: Build Docker images
+        run: make build
+        env:
+          PYTHON_IMAGE_VER: "${{ matrix.python-version }}"
+
+      - name: Migrate Database
+        run: |
+          make migrate || echo "::warning:: migrate failed on future Python version ${{ matrix.python-version }}."
+
+      - name: Run Application
+        run: |
+          make run || echo "::warning:: run failed on future Python version ${{ matrix.python-version }}."
+
+      - name: Check Docker state (pre-test)
+        run: docker ps
+
+      - name: Run pytest + behave with Coverage
+        env:
+          POSTGRES_USER: scram
+          POSTGRES_DB: test_scram
+        run: |
+          make coverage.xml || echo "::warning:: pytest + behave failed on future Python version ${{ matrix.python-version }}."
+
+      - name: Dump docker logs on failure
+        if: failure()
+        uses: jwalton/gh-docker-logs@v2
+
+      - name: Check Docker state (post-test)
+        if: always()
+        run: docker ps
+
+      - name: Stop Services
+        if: always()
+        run: make stop
+
+      - name: Clean Up
+        if: always()
+        run: make clean

.github/workflows/docs.yml

@@ -1,9 +1,9 @@
 name: Build sphinx docs
 
 on:
-  # Runs on pushes targeting the default branch
   push:
-    branches: ["main"]
+    branches:
+      - 'main'
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -41,12 +41,17 @@ jobs:
       - name: "[pytest]: before"
         run: "./.ci-scripts/pytest_before.sh"
 
+      - name: Build docs
+        run: make docs-build
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
           # Upload entire repository
-          path: 'docs/_build/html'
+          path: 'site/'
 
       - name: Deploy to GitHub Pages
+        if: github.ref == 'refs/heads/main'
         id: deployment
         uses: actions/deploy-pages@v4
+

.github/workflows/pytest.yml

@@ -0,0 +1,77 @@
+---
+name: Run pytest
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - main
+      - develop
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  pytest:
+    name: Run Pytest
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: ['3.11', '3.12']
+
+    services:
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_USER: scram
+          POSTGRES_PASSWORD: ''
+          POSTGRES_DB: test_scram_${{ matrix.python-version }}
+          POSTGRES_HOST_AUTH_METHOD: trust
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd "pg_isready -U scram"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+      redis:
+        image: redis:5.0
+        ports:
+          - 6379:6379
+
+    steps:
+      - name: Check out the code
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements/local.txt
+          # https://github.com/pytest-dev/pytest-github-actions-annotate-failures/pull/68 isn't yet in a release
+          pip install git+https://github.com/pytest-dev/pytest-github-actions-annotate-failures.git@6e66cd895fe05cd09be8bad58f5d79110a20385f
+
+      - name: Apply migrations
+        env:
+          DATABASE_URL: "postgres://scram:@localhost:5432/test_scram_${{ matrix.python-version }}"
+        run: |
+          python manage.py makemigrations --noinput
+          python manage.py migrate --noinput
+
+      - name: Check for missing migrations
+        env:
+          DATABASE_URL: "postgres://scram:@localhost:5432/test_scram_${{ matrix.python-version }}"
+        run: python manage.py makemigrations --check
+
+      - name: Run Pytest
+        env:
+          DATABASE_URL: "postgres://scram:@localhost:5432/test_scram_${{ matrix.python-version }}"
+          REDIS_HOST: "localhost"
+        run: pytest

.github/workflows/pytest_next_python.yml

@@ -0,0 +1,88 @@
+---
+name: Run pytest with unsupported Python versions
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - main
+      - develop
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  pytest_next_python:
+    name: Run Pytest
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: ['3.13']
+
+    services:
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_USER: scram
+          POSTGRES_PASSWORD: ''
+          POSTGRES_DB: test_scram
+          POSTGRES_HOST_AUTH_METHOD: trust
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd "pg_isready -U scram"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+      redis:
+        image: redis:5.0
+        ports:
+          - 6379:6379
+
+    steps:
+      - name: Check out the code
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements/local.txt
+          # https://github.com/pytest-dev/pytest-github-actions-annotate-failures/pull/68 isn't yet in a release
+          pip install git+https://github.com/pytest-dev/pytest-github-actions-annotate-failures.git@6e66cd895fe05cd09be8bad58f5d79110a20385f
+
+      - name: Apply unapplied migrations
+        env:
+          DATABASE_URL: "postgres://scram:@localhost:5432/test_scram"
+        run: |
+          python manage.py makemigrations --noinput || true
+          UNAPPLIED_MIGRATIONS=$(python manage.py showmigrations --plan | grep '\[ \]' | awk '{print $2}')
+          if [ -n "$UNAPPLIED_MIGRATIONS" ]; then
+            for migration in $UNAPPLIED_MIGRATIONS; do
+              python manage.py migrate $migration --fake-initial --noinput
+            done
+          else
+            echo "No unapplied migrations."
+          fi
+
+      - name: Check for duplicate migrations
+        run: |
+          if python manage.py makemigrations --dry-run | grep "No changes detected"; then
+            echo "No duplicate migrations detected."
+          else
+            echo "Warning: Potential duplicate migrations detected. Please review."
+          fi
+
+      - name: Run Pytest
+        env:
+          DATABASE_URL: "postgres://scram:@localhost:5432/test_scram"
+          REDIS_HOST: "localhost"
+        run: |
+          pytest || echo "::warning:: Failed on future Python version ${{ matrix.python-version }}."