chore: use test container

Author: tianzhou

.github/workflows/pgschema-plan-single.yml

@@ -15,6 +15,24 @@ jobs:
   pgschema-plan-single:
     runs-on: ubuntu-latest
 
+    env:
+      PGPASSWORD: postgres
+    
+    services:
+      postgres:
+        image: postgres:17
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_USER: postgres
+          POSTGRES_DB: testdb
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -27,63 +45,50 @@ jobs:
       - name: Install pgschema
         run: go install github.com/pgschema/pgschema@latest
 
-      - name: Run pgschema plan
-        id: plan
+      - name: Setup baseline schema from main branch
         run: |
-          # Debug: Print environment info
-          echo "::group::Environment Info"
-          echo "Current directory: $(pwd)"
-          echo "Schema file path: ${{ github.workspace }}/singlefile/schema.sql"
-          echo "Checking if schema file exists:"
-          ls -la "${{ github.workspace }}/singlefile/schema.sql" || echo "Schema file not found!"
-          echo "Go version: $(go version)"
-          echo "pgschema location: $(which pgschema)"
-          echo "::endgroup::"
+          # Checkout main branch to get baseline schema
+          git fetch origin main
+          git checkout origin/main -- singlefile/schema.sql || {
+            echo "::error::Could not checkout schema.sql from main branch"
+            exit 1
+          }
           
-          # Debug: Test pgschema is installed
-          echo "::group::Testing pgschema installation"
-          pgschema --version || echo "Failed to run pgschema --version"
-          echo "::endgroup::"
+          # Copy main branch schema to temporary location
+          cp singlefile/schema.sql /tmp/main_schema.sql
+          
+          # Restore current branch schema
+          git checkout HEAD -- singlefile/schema.sql
           
-          # Run pgschema plan with timeout and capture output
-          echo "::group::Running pgschema plan"
-          set +e  # Don't exit on error
-          PLAN_OUTPUT=$(timeout 60s pgschema plan \
+          # Apply main branch schema to establish baseline database state
+          echo "::group::Applying baseline schema"
+          pgschema apply \
+            --auto-approve \
+            --host localhost \
+            --port 5432 \
+            --db testdb \
+            --user postgres \
+            --file /tmp/main_schema.sql \
+            || echo "::warning::Failed to apply baseline schema"
+          echo "::endgroup::"
+        
+      - name: Run pgschema plan
+        id: plan
+        run: |
+          # Run pgschema plan
+          PLAN_OUTPUT=$(pgschema plan \
             --debug \
-            --host "${{ secrets.DB_HOST }}" \
-            --port "${{ secrets.DB_PORT }}" \
-            --db "${{ secrets.DB_NAME }}" \
-            --user "${{ secrets.DB_USER }}" \
+            --host localhost \
+            --port 5432 \
+            --db testdb \
+            --user postgres \
             --file "${{ github.workspace }}/singlefile/schema.sql" \
             --format human 2>&1)
-          EXIT_CODE=$?
-          set -e  # Re-enable exit on error
-          echo "::endgroup::"
-          
-          # Check exit code
-          if [ $EXIT_CODE -eq 124 ]; then
-            echo "::error::pgschema plan timed out after 60 seconds"
-            PLAN_OUTPUT="Error: pgschema plan timed out after 60 seconds. This might indicate a connection issue to the database."
-          elif [ $EXIT_CODE -ne 0 ]; then
-            echo "::error::pgschema plan failed with exit code $EXIT_CODE"
-          fi
-          
-          # Debug: Show raw output
-          echo "::group::Raw pgschema output"
-          echo "$PLAN_OUTPUT"
-          echo "::endgroup::"
-          
-          # Escape special characters for GitHub Actions
-          PLAN_OUTPUT="${PLAN_OUTPUT//'%'/'%25'}"
-          PLAN_OUTPUT="${PLAN_OUTPUT//$'\n'/'%0A'}"
-          PLAN_OUTPUT="${PLAN_OUTPUT//$'\r'/'%0D'}"
           
           # Set output
           echo "plan<<EOF" >> $GITHUB_OUTPUT
           echo "$PLAN_OUTPUT" >> $GITHUB_OUTPUT
           echo "EOF" >> $GITHUB_OUTPUT
-        env:
-          PGPASSWORD: ${{ secrets.DB_PASSWORD }}
           
       - name: Comment PR
         uses: actions/github-script@v7

README.md

@@ -15,8 +15,12 @@ Both workflows automatically:
 
 ## Setup
 
-### 1. Required GitHub Secrets
+### 1. GitHub Secrets
 
+#### Single File Workflow
+No secrets required! The single-file workflow uses a PostgreSQL 17 test container for demonstration purposes.
+
+#### Multi File Workflow (if using external database)
 Configure the following secrets in your repository settings:
 
 - `DB_HOST` - PostgreSQL database host (default: localhost)
@@ -30,6 +34,8 @@ Configure the following secrets in your repository settings:
 #### Single File Approach
 - Place your complete schema in `singlefile/schema.sql`
 - All tables, indexes, functions, and triggers in one file
+- Uses PostgreSQL 17 test container (no external database needed)
+- Compares current branch schema against main branch schema
 - Workflow: `.github/workflows/pgschema-plan-single.yml`
 
 #### Multi File Approach
@@ -72,6 +78,12 @@ This structure demonstrates how to organize complex schemas across multiple file
 
 ## Security Notes
 
+### Single File Workflow
+- Uses isolated PostgreSQL 17 test container
+- No external database credentials required
+- Safe for demonstration and testing purposes
+
+### Multi File Workflow  
 - Database credentials are stored as encrypted GitHub secrets
 - The workflow only has read access to your database (it runs `plan`, not `apply`)
 - Consider using a read-only database user for additional security