From bdd7958672f89a92f4d251585e12b8969b4616e7 Mon Sep 17 00:00:00 2001
From: Daniel Perrefort <djperrefort@gmail.com>
Date: Mon, 4 Dec 2023 14:57:00 -0500
Subject: [PATCH] Adds cmments to test workflow

---
 .github/workflows/Test.yml | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/Test.yml b/.github/workflows/Test.yml
index 8ff6a32f..a5b7be39 100644
--- a/.github/workflows/Test.yml
+++ b/.github/workflows/Test.yml
@@ -4,6 +4,9 @@ on:
   workflow_call:
 
 jobs:
+
+  # System configuration tests including checks for obviously
+  # incorrect settings and missing database migrations
   system-checks:
     name: System Checks
     runs-on: ubuntu-latest
@@ -24,6 +27,8 @@ jobs:
       - name: Run migration checks
         run: docker run test-image makemigrations --check
 
+  # Integration test requiring all API health checks to pass
+  # when launching the docker container with default settings.
   health-checks:
     name: API Health Checks
     runs-on: ubuntu-latest
@@ -41,7 +46,7 @@ jobs:
       - name: Run API health checks
         run: |
           docker run --detach -p 8000:8000 test-image
-          sleep 30
+          sleep 30  # Wait for API server to start
           
           http_status=$(wget -NS localhost:8000/health/ 2>&1 | grep "HTTP/" | awk '{print $2}')
           jq . index.html
@@ -49,6 +54,7 @@ jobs:
             exit 1
           fi
 
+  # Run any/all application tests using the Django `test` utility
   app-tests:
     name: Application Tests
     runs-on: ubuntu-latest