get pr number from gh action event json file, fallback to old behaviour

Author: mohammedahmed18

.github/workflows/codeflash-optimize.yaml

@@ -20,7 +20,6 @@ jobs:
       CODEFLASH_AIS_SERVER: prod
       POSTHOG_API_KEY: ${{ secrets.POSTHOG_API_KEY }}
       CODEFLASH_API_KEY: ${{ secrets.CODEFLASH_API_KEY }}
-      CODEFLASH_PR_NUMBER: ${{ github.event.number }}
       COLUMNS: 110
     steps:
       - name: 🛎️ Checkout

codeflash/cli_cmds/workflows/codeflash-optimize.yaml

@@ -21,7 +21,6 @@ jobs:
     runs-on: ubuntu-latest
     env:
       CODEFLASH_API_KEY: ${{ secrets.CODEFLASH_API_KEY }}
-      CODEFLASH_PR_NUMBER: ${{ github.event.number }}
     {{ working_directory }}
     steps:
       - name: 🛎️ Checkout

codeflash/code_utils/env_utils.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import json
 import os
 import tempfile
 from functools import lru_cache
@@ -64,6 +65,10 @@ def ensure_codeflash_api_key() -> bool:
 
 @lru_cache(maxsize=1)
 def get_pr_number() -> Optional[int]:
+    event_data = get_cached_gh_event_data()
+    gh_pr_number = event_data["number"]
+    if gh_pr_number is not None:
+        return int(gh_pr_number)
     pr_number = os.environ.get("CODEFLASH_PR_NUMBER")
     if not pr_number:
         return None
@@ -73,8 +78,8 @@ def get_pr_number() -> Optional[int]:
 def ensure_pr_number() -> bool:
     if not get_pr_number():
         msg = (
-            "CODEFLASH_PR_NUMBER not found in environment variables; make sure the Github Action is setting this so "
-            "Codeflash can comment on the right PR"
+            "Codeflash couldn't detect your pull request number. Are you running Codeflash within a GitHub Action?"
+            "If not, please set the CODEFLASH_PR_NUMBER environment variable to ensure Codeflash can comment on the correct PR."
         )
         raise OSError(msg)
     return True
@@ -83,3 +88,12 @@ def ensure_pr_number() -> bool:
 @lru_cache(maxsize=1)
 def is_end_to_end() -> bool:
     return bool(os.environ.get("CODEFLASH_END_TO_END"))
+
+
+@lru_cache(maxsize=1)
+def get_cached_gh_event_data() -> dict[str,]:
+    event_path = os.getenv("GITHUB_EVENT_PATH")
+    if not event_path:
+        return {}
+    with Path(event_path).open() as f:
+        return json.load(f)

docs/docs/getting-started/codeflash-github-actions.md

@@ -57,7 +57,6 @@ jobs:
     runs-on: ubuntu-latest
     env:
       CODEFLASH_API_KEY: ${{ secrets.CODEFLASH_API_KEY }}
-      CODEFLASH_PR_NUMBER: ${{ github.event.number }}
     steps:
       - uses: actions/checkout@v4
         with: