fix: wait for Copilot review workflow before merging

codepuncher · Copilot · codepuncher · commit 43c75c8e7759 · 2026-02-27T00:22:51.000Z
CRITICAL FIX: Copilot review runs as GitHub Actions workflow that takes 1-3 minutes. Previously instructions told Copilot CLI to merge after CI passes, but before review workflow completed, causing critical bugs to be missed. Root cause analysis: - Copilot review is 'Copilot code review' GitHub Actions workflow - Workflow starts ~5s after PR created, takes 1-3 minutes to complete - CI checks (Lint, etc.) complete in <1 minute - Old instructions merged after CI, before review workflow finished Real examples of the problem: - PR #147: Merged at 43s, review workflow completed at 2m24s - PR #149: Merged at 1m51s, review workflow completed at 3m2s - PR #150: Merged at 6m56s, review workflow completed at 7m5s Solution: - Wait for CI: gh pr checks --watch - Wait for review workflow: Loop checking for review from copilot-pull-request-reviewer bot - Only merge after BOTH complete Updated sections: - Merging to Default Branch (lines 721-817) - Pattern 1: FreshDesk workflow (lines 288-301) - Pattern 2: PR comments workflow (lines 335-347) - Pattern 3: ClickUp feature workflow (lines 396-409) - Complete Workflow section (lines 602-604) - Quick Reference Commands (lines 1308-1318) This prevents PRs from being merged before automated review completes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diff --git a/shell/copilot-instructions.md b/shell/copilot-instructions.md
@@ -285,12 +285,22 @@ wp @staging cache flush
 # 9. Mark PR as ready for review
 gh pr ready
 
-# 10. Wait for both CI and Copilot review to complete
-# Check status (don't merge until both are done):
-gh pr view <pr-number> --json reviews,reviewRequests
-
-# 11. After all reviews complete, merge
-gh pr checks <pr-number> --watch && gh pr merge <pr-number> -m -d --admin
+# 10. Wait for CI to pass
+gh pr checks <pr-number> --watch
+
+# 11. Wait for Copilot review workflow to complete (DON'T SKIP THIS)
+while true; do
+    REVIEW=$(gh pr view <pr-number> --json reviews -q '.reviews[] | select(.author.login == "copilot-pull-request-reviewer") | .submittedAt')
+    if [ -n "$REVIEW" ]; then
+        echo "✓ Copilot review complete"
+        break
+    fi
+    echo "⏳ Waiting for Copilot review workflow... (30s)"
+    sleep 30
+done
+
+# 12. After BOTH CI and Copilot workflow complete, merge
+gh pr merge <pr-number> -m -d --admin
 ```
 
 ### Pattern 2: Address PR Code Review Comments
@@ -328,11 +338,22 @@ gh pr edit <pr-number> --add-reviewer @copilot
 # 9. Deploy to staging to verify all fixes
 git push origin HEAD:staging --force
 
-# 10. Wait for new Copilot review to complete, then merge
-# Check review status first
-gh pr view <pr-number> --json reviews,reviewRequests
-# After Copilot review is complete (not just CI):
-gh pr checks <pr-number> --watch && gh pr merge <pr-number> -m -d --admin
+# 10. Wait for CI checks to pass
+gh pr checks <pr-number> --watch
+
+# 11. Wait for Copilot review workflow to complete
+while true; do
+    REVIEW=$(gh pr view <pr-number> --json reviews -q '.reviews[] | select(.author.login == "copilot-pull-request-reviewer") | .submittedAt')
+    if [ -n "$REVIEW" ]; then
+        echo "✓ Copilot review complete"
+        break
+    fi
+    echo "⏳ Waiting for Copilot review workflow... (30s)"
+    sleep 30
+done
+
+# 12. After both CI and Copilot workflow complete, merge
+gh pr merge <pr-number> -m -d --admin
 ```
 
 ### Pattern 3: Implement New Feature from ClickUp
@@ -385,11 +406,22 @@ git push origin HEAD:staging --force
 # 7. Mark ready and get review
 gh pr ready
 
-# 10. Wait for CI checks AND Copilot review, then merge
-# IMPORTANT: Check that @copilot review is complete (not just CI)
-gh pr view <pr-number> --json reviewRequests,reviews
-# If no pending review requests and Copilot has reviewed, proceed:
-gh pr checks <pr-number> --watch && gh pr merge <pr-number> -m -d --admin
+# 8. Wait for CI to pass
+gh pr checks <pr-number> --watch
+
+# 9. Wait for Copilot review workflow to complete (REQUIRED)
+while true; do
+    REVIEW=$(gh pr view <pr-number> --json reviews -q '.reviews[] | select(.author.login == "copilot-pull-request-reviewer") | .submittedAt')
+    if [ -n "$REVIEW" ]; then
+        echo "✓ Copilot review complete"
+        break
+    fi
+    echo "⏳ Waiting for Copilot review workflow... (30s)"
+    sleep 30
+done
+
+# 10. After both CI and Copilot workflow complete, merge
+gh pr merge <pr-number> -m -d --admin
 
 # 9. Verify production deployment
 # (happens automatically when default branch is pushed)
@@ -587,9 +619,10 @@ When implementing a feature or fix:
 7. **Address code review feedback** - Validate accuracy, reply in threads, resolve when fixed
 8. **Deploy to staging for testing** - `git push origin <branch>:staging --force`
 9. **Verify changes on staging** - Test that the fix/feature works correctly
-10. **Wait for reviews to complete** - Check both CI and Copilot review status with `gh pr view <pr> --json reviews,reviewRequests`
-11. **Merge to default branch** - After all reviews complete: `gh pr checks <pr> --watch && gh pr merge <pr> -m -d --admin`
-12. **Production deployment** - Happens automatically when default branch is pushed
+10. **Wait for CI checks to pass** - `gh pr checks <pr> --watch`
+11. **Wait for Copilot review workflow to complete** - Use loop to check for review from copilot-pull-request-reviewer
+12. **Merge to default branch** - `gh pr merge <pr> -m -d --admin` (only after both CI and Copilot review complete)
+13. **Production deployment** - Happens automatically when default branch is pushed
 
 **Key points:**
 - Always verify on staging BEFORE merging to default branch
@@ -707,32 +740,105 @@ Use `gh-pr-get-comments` script to retrieve all comments on a PR:
 
 ### Merging to Default Branch
 
-**IMPORTANT: Wait for ALL reviews (not just CI) before merging:**
+**🚨 CRITICAL: NEVER merge until BOTH CI passes AND Copilot review workflow completes**
+
+**The Problem:** Copilot review runs as a GitHub Actions workflow that takes 1-3 minutes. If you merge before it completes, you'll miss critical bugs.
+
+**How Copilot Review Works:**
+- Triggered automatically when PR is created/updated
+- Runs as "Copilot code review" GitHub Actions workflow
+- Takes 1-3 minutes to analyze code and post review
+- Must wait for workflow to complete, not just CI checks
+
+**Required Workflow:**
 
 ```bash
-# 1. Check review status (do this BEFORE merging)
-gh pr view <pr-number> --json reviews,reviewRequests
+# 1. Wait for CI checks (Lint, etc.)
+gh pr checks <pr-number> --watch
+
+# 2. Wait for Copilot review workflow to complete (REQUIRED - don't skip!)
+while true; do
+    # Check if Copilot review workflow is complete
+    REVIEW=$(gh pr view <pr-number> --json reviews -q '.reviews[] | select(.author.login == "copilot-pull-request-reviewer") | .submittedAt')
+    if [ -n "$REVIEW" ]; then
+        echo "✓ Copilot review complete at $REVIEW"
+        break
+    fi
+    echo "⏳ Waiting for Copilot review workflow... (checking again in 30s)"
+    sleep 30
+done
+
+# 3. Now safe to merge
+gh pr merge <pr-number> -m -d --admin
+```
 
-# Look for:
-# - "reviewRequests": [] (empty means no pending review requests)
-# - "reviews": [...] (should include copilot-pull-request-reviewer)
+**Alternative - Check workflow runs directly:**
+```bash
+# Wait for CI
+gh pr checks <pr-number> --watch
+
+# Get PR number from branch
+PR_NUM=$(gh pr view --json number -q .number)
+
+# Wait for Copilot review workflow to complete
+while true; do
+    STATUS=$(gh run list --repo $(gh repo view --json nameWithOwner -q .nameWithOwner) \
+      --workflow="Copilot code review" --json headBranch,status,conclusion \
+      --jq ".[] | select(.headBranch == \"refs/pull/${PR_NUM}/head\") | .status")
+    
+    if [ "$STATUS" = "completed" ]; then
+        echo "✓ Copilot review workflow complete"
+        break
+    fi
+    echo "⏳ Copilot review workflow status: $STATUS (checking again in 30s)"
+    sleep 30
+done
+
+# Now safe to merge
+gh pr merge <pr-number> -m -d --admin
+```
+
+**How to check manually:**
+```bash
+# Check if Copilot review exists (posted by workflow)
+gh pr view <pr-number> --json reviews -q '.reviews[] | select(.author.login == "copilot-pull-request-reviewer")'
 
-# 2. If Copilot review is still pending, WAIT
-# Copilot reviews can take 1-3 minutes after CI passes
+# If empty: workflow hasn't completed yet - WAIT
+# If shows data: workflow complete - OK TO MERGE
 
-# 3. Only merge after BOTH CI checks pass AND reviews complete
-gh pr checks <pr-number> --watch --interval 2 && gh pr merge <pr-number> -m -d --admin
+# Or check workflow run status
+gh run list --workflow="Copilot code review" --limit 5
+```
+
+**WRONG (what causes the problem):**
+```bash
+# ❌ BAD: Merges after CI only, doesn't wait for Copilot review workflow
+gh pr checks <pr-number> --watch && gh pr merge <pr-number> -m -d --admin
 ```
 
-- Before merging, ensure:
-  1. Most recent commit was deployed to staging and verified
-  2. CI checks have passed
-  3. Copilot review has completed (not just requested)
-  4. Any review comments have been addressed
-- Or use the alias: `gh_check_merge <pr-number> --admin` (but check reviews first manually)
-- The `--admin` flag bypasses branch protection rules
-- The `-m -d` flags merge and delete the branch after merging
-- **Note**: This is only for merging to the default branch, NOT for deploying to staging
+**Before merging, verify ALL of these:**
+1. ✅ Most recent commit was deployed to staging and verified
+2. ✅ CI checks (Lint, etc.) have passed
+3. ✅ Copilot review workflow has completed (review posted by copilot-pull-request-reviewer)
+4. ✅ Any review comments have been addressed
+
+**Real examples of the problem:**
+- PR #147: Merged 43s after creation, review workflow completed at 2m24s
+- PR #149: Merged at 00:01:51, review workflow completed at 00:03:02 (1m11s after merge)
+- PR #150: Merged at 00:06:56, review workflow completed at 00:07:05 (9s after merge - close!)
+
+**Timing data:**
+- Copilot review workflow starts ~5 seconds after PR created
+- Workflow takes 1-3 minutes to complete
+- CI checks usually complete in <1 minute
+- **Problem:** CI finishes before review workflow
+
+**⚠️ Do NOT use:**
+- `gh_check_merge` alias (only waits for CI, not Copilot workflow)
+- `gh pr checks --watch && gh pr merge` (skips Copilot workflow check)
+- Any command that merges immediately after CI passes
+
+**This is only for merging to default branch**, NOT for deploying to staging.
 
 ### After Pushing
 
@@ -1199,14 +1305,20 @@ git push -u origin HEAD
 # Open draft PR
 gh pr create --draft --fill
 
-# Check review status (before merging)
-gh pr view <pr-number> --json reviews,reviewRequests
+# Wait for CI and Copilot review workflow, then merge
+gh pr checks <pr-number> --watch
 
-# Check CI status and merge (only after reviews complete)
-gh pr checks <pr-number> --watch && gh pr merge <pr-number> -m -d --admin
+# Wait for Copilot review workflow to complete
+while true; do
+    REVIEW=$(gh pr view <pr-number> --json reviews -q '.reviews[] | select(.author.login == "copilot-pull-request-reviewer") | .submittedAt')
+    if [ -n "$REVIEW" ]; then
+        break
+    fi
+    sleep 30
+done
 
-# Or use alias
-gh_check_merge <pr-number> --admin
+# After BOTH complete, merge
+gh pr merge <pr-number> -m -d --admin
 
 # Deploy any branch to staging
 git push origin <branch-name>:staging --force
