Merge pull request #4192 from bcgov/chore-fix-nightly-build-schemaspy-and-happo

Fix nightly build schemaspy and happo

Author: dleard

.github/workflows/schemaspy.yaml

@@ -27,13 +27,10 @@ jobs:
           --health-retries 5
         ports:
           - 5432:5432
-    timeout-minutes: 10
+    timeout-minutes: 20
     steps:
       - uses: actions/checkout@v6
         name: checkout code
-        with:
-          sparse-checkout: |
-            bc_obps/
       - name: vars
         id: vars
         shell: bash

.github/workflows/test-nx-project-e2e.yaml

@@ -118,7 +118,7 @@ jobs:
           HAPPO_API_SECRET: ${{ github.event_name == 'schedule' && '' || secrets.HAPPO_API_SECRET }}
           HAPPO_PROJECT: cas-${{ inputs.nx_project }}
           SMTP_CONNECTION_STRING: smtp://@localhost:1025
-        run: DEBUG=pw:api yarn nx run "$NX_PROJECT":e2e:ci -- --project=chromium
+        run: DEBUG=pw:api yarn nx run "$NX_PROJECT":${{ github.event_name == 'schedule' && 'e2e' || 'e2e:ci' }} -- --project=chromium
         working-directory: ./bciers
 
 #      #     Reports weren't being used regularly though leaving this in here for debugging purposes.
@@ -159,7 +159,7 @@ jobs:
 
   # Call Happo api and skip the project if it wasn't affected
   happo-skip-not-affected:
-    if: ${{ !inputs.is_nx_affected && github.ref_name != 'develop' && github.ref_name != 'main' && github.head_ref != 'develop' && github.head_ref != 'main' || github.event_name == 'schedule' }}
+    if: ${{ !inputs.is_nx_affected && github.ref_name != 'develop' && github.ref_name != 'main' && github.head_ref != 'develop' && github.head_ref != 'main' && github.event_name != 'schedule' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6

docs/testing-workflows-before-merging.md

@@ -0,0 +1,61 @@
+# Testing GitHub Actions Workflows Before Merging
+
+When modifying reusable or scheduled workflows (e.g., `nightly.yaml`, `schemaspy.yaml`), you often can't test changes directly because:
+
+- **Scheduled workflows** (`on: schedule`) always run from the default branch.
+- **`workflow_dispatch`** only works for workflows that already exist on the default branch.
+- **Reusable workflows** (`on: workflow_call`) can't be triggered directly.
+
+## Recommended Approach: Temporary Push-Triggered Workflow
+
+Create a temporary workflow file on your feature branch that triggers on `push` and calls the reusable workflow you're testing.
+
+### 1. Create the temporary workflow
+
+Add a file like `.github/workflows/test-my-fix.yaml`:
+
+```yaml
+# Temporary workflow - delete before merging.
+name: Test My Fix
+
+on:
+  push:
+    branches:
+      - my-feature-branch
+
+jobs:
+  test-job:
+    uses: ./.github/workflows/the-reusable-workflow.yaml
+    secrets: inherit
+```
+
+### 2. Commit and push
+
+Push the temporary workflow along with your fixes. The workflow runs automatically on push, using the reusable workflow files **from your branch** (not from `develop`).
+
+### 3. Check results
+
+**Using the GitHub UI:**
+
+1. Go to the repository on GitHub.
+2. Click the **Actions** tab.
+3. Find your workflow name (e.g., "Test My Fix") in the left sidebar.
+4. Click into the run to see step-by-step logs and status.
+5. If a run was canceled by a concurrent push, click **Re-run all jobs** to retry.
+
+**Using the GitHub CLI (optional):**
+
+```bash
+gh run list --workflow=test-my-fix.yaml
+gh run watch
+```
+
+### 4. Clean up
+
+Delete the temporary workflow file before merging your PR.
+
+## Limitations
+
+- **`github.event_name`** will be `push`, not `schedule`. Conditionals that check for `schedule` (e.g., disabling Happo) won't activate. For those, verify the logic by reading the code; the conditional behavior itself is deterministic.
+- **Concurrency settings** in the reusable workflow may cancel runs if you push multiple times quickly. Wait for a run to finish or re-run from the Actions tab.
+- **Timeouts** from the reusable workflow still apply. If a full checkout replaces a sparse checkout, you may need to increase the timeout.