fix: cicd bot correctly surface plan errors (#4646)

Author: eakmanrq

sqlmesh/integrations/github/cicd/command.py

@@ -185,9 +185,11 @@ def _deploy_production(controller: GithubController) -> bool:
             skip_reason=str(e),
         )
         return False
-    except PlanError:
+    except PlanError as e:
         controller.update_prod_environment_check(
-            status=GithubCheckStatus.COMPLETED, conclusion=GithubCheckConclusion.ACTION_REQUIRED
+            status=GithubCheckStatus.COMPLETED,
+            conclusion=GithubCheckConclusion.ACTION_REQUIRED,
+            plan_error=e,
         )
         return False
     except Exception:

sqlmesh/integrations/github/cicd/controller.py

@@ -977,6 +977,7 @@ def update_prod_environment_check(
         status: GithubCheckStatus,
         conclusion: t.Optional[GithubCheckConclusion] = None,
         skip_reason: t.Optional[str] = None,
+        plan_error: t.Optional[PlanError] = None,
     ) -> None:
         """
         Updates the status of the merge commit for the prod environment.
@@ -990,6 +991,7 @@ def conclusion_handler(
                 GithubCheckConclusion.CANCELLED: "Cancelled deploying to prod",
                 GithubCheckConclusion.SKIPPED: skip_reason,
                 GithubCheckConclusion.FAILURE: "Failed to deploy to prod",
+                GithubCheckConclusion.ACTION_REQUIRED: "Failed due to error applying plan",
             }
             title = (
                 conclusion_to_title.get(conclusion)
@@ -1002,6 +1004,11 @@ def conclusion_handler(
                 summary = (
                     captured_errors or f"{title}\n\n**Error:**\n```\n{traceback.format_exc()}\n```"
                 )
+            elif conclusion.is_action_required:
+                if plan_error:
+                    summary = f"**Plan error:**\n```\n{plan_error}\n```"
+                else:
+                    summary = "Got an action required conclusion but no plan error was provided. This is unexpected."
             else:
                 summary = "**Generated Prod Plan**\n" + self.get_plan_summary(self.prod_plan)
             return conclusion, title, summary

tests/integrations/github/cicd/test_github_commands.py

@@ -884,6 +884,15 @@ def raise_on_prod_plan(plan: Plan):
     assert GithubCheckStatus(prod_checks_runs[1]["status"]).is_in_progress
     assert GithubCheckStatus(prod_checks_runs[2]["status"]).is_completed
     assert GithubCheckConclusion(prod_checks_runs[2]["conclusion"]) == expect_prod_sync_conclusion
+    if expect_prod_sync_conclusion.is_action_required:
+        assert prod_checks_runs[2]["output"]["title"] == "Failed due to error applying plan"
+        assert (
+            prod_checks_runs[2]["output"]["summary"]
+            == f"""**Plan error:**
+```
+{to_raise_on_prod_plan}
+```"""
+        )
 
     assert "SQLMesh - Run Unit Tests" in controller._check_run_mapping
     test_checks_runs = controller._check_run_mapping["SQLMesh - Run Unit Tests"].all_kwargs