fix(github_action): handle synchronize event for push trigger (#2455) (#2490)

* fix: scope ticket cache per-PR and fix Dynaconf list merge leaks in tests

- Cache key is now 'related_tickets_<md5(pr_url)>' instead of global
  'related_tickets', preventing stale tickets leaking between unrelated PRs
- Added cache_tickets=true config flag under [pr_reviewer] to allow disabling
- Fixed Dynaconf merge_enabled=True list append bug in both production code
  (env_bridge.py uses case-insensitive pop before set) and test helpers
  (restore_settings now calls _remove_key before every set)
- Added azure-identity dependency for Azure DevOps provider availability
- 1043 tests pass, 0 failures

* Revert "fix: scope ticket cache per-PR and fix Dynaconf list merge leaks in tests"

This reverts commit 7f0d154.

* fix(github_action): handle synchronize event for push trigger (#2455)

* fix: address bot review comments for synchronize (#2455)

- Check github_action_config.handle_push_trigger first (defaults true)
- Remove hardcoded push_commands fallback list
- Add before==after SHA guard
- Add unit tests for synchronize handling

* fix: address bot review comments on PR #2490

- Remove unused merge_commit_sha variable (F841)
- Use is_true() to handle string values for push_trigger

* fix: address review feedback for synchronize event handler

- Guard before/after SHA check against None to avoid skipping when
  payload lacks these fields
- Revert misleading test rename (test_issue_comment_from_user_is_processed)
- Remove unused merge_commit_sha parameter from _write_synchronize_event
- Add test coverage for pull_request_target with synchronize event

* fix: address review feedback - default handle_push_trigger to false, add merge-commit/bot guards, fix push_commands fallback

* fix: address Qodo comments - reorder synchronize before pr_actions, add string guard for push_commands, mirror settings in config, fix test leak

* chore: remove accidentally added skpro submodule

* docs: document synchronize/push trigger for GitHub Action

* chore: remove accidentally added skpro submodule

* chore: add skpro to gitignore

* fix: address Qodo findings v2 - unblock github_app fallback, reorder synchronize to not bypass pr_actions, use set() for test setup, add return after push commands

* docs: document synchronize/push trigger and guards for GitHub Action

* docs: clarify synchronize is opt-in with default false

---------

Co-authored-by: Utsab <utsab@pr-agent.dev>

Author: utsab345

docs/docs/usage-guide/automations_and_usage.md

@@ -147,9 +147,9 @@ pr_commands = [
 ]
 ```
 
-#### GitHub app automatic tools for push actions (commits to an open PR)
+#### Automatic tools for push actions (commits to an open PR)
 
-In addition to running automatic tools when a PR is opened, the GitHub app can also respond to new code that is pushed to an open PR.
+In addition to running automatic tools when a PR is opened, PR-Agent can also respond to new code that is pushed to an open PR. This works for both **GitHub App** and **GitHub Action** deployments.
 
 The configuration toggle `handle_push_trigger` can be used to enable this feature.
 The configuration parameter `push_commands` defines the list of tools that will be **run automatically** when new code is pushed to the PR.
@@ -163,6 +163,8 @@ push_commands = [
 ]
 ```
 
+For GitHub Action, settings fall back from `github_action_config.*` to `github_app.*`, so you can set either section.
+
 This means that when new code is pushed to the PR, PR-Agent will run the `describe` and `review` tools, with the specified parameters.
 
 ### GitHub Action
@@ -186,6 +188,15 @@ If not set, the default configuration is for all three tools to run automaticall
 
 `github_action_config.pr_actions` is used to configure which `pull_requests` events will trigger the enabled auto flags
 If not set, the default configuration is `["opened", "reopened", "ready_for_review", "review_requested"]`
+Adding `"synchronize"` to this list enables auto tools on new commits pushed to an open PR. You must also add `synchronize` to the workflow `pull_request: types:` list.
+
+`github_action_config.handle_push_trigger` controls whether synchronize events run the push commands (default `false`). Settings fall back to `github_app.*` if not set under `github_action_config`. Since it defaults to `false`, synchronize is opt-in — you must explicitly enable it by either adding `"synchronize"` to `pr_actions` or setting `handle_push_trigger = true`.
+
+`github_action_config.push_commands` defines which tools run on synchronize events when `handle_push_trigger` is enabled (fallback to `github_app.push_commands`).
+
+`github_action_config.push_trigger_ignore_merge_commits` (default `true`) skips processing when the push contains a merge commit, avoiding duplicate reviews on "Update branch" clicks.
+
+`github_action_config.push_trigger_ignore_bot_commits` (default `true`) skips processing when the push author is a bot, avoiding redundant runs on automated commits.
 
 `github_action_config.enable_output` are used to enable/disable github actions [output parameter](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-docker-container-and-javascript-actions) (default is `true`).
 Review result is output as JSON to `steps.{step-id}.outputs.review` property.

pr_agent/servers/github_action_runner.py

@@ -113,6 +113,52 @@ async def run_action():
         # Retrieve the list of actions from the configuration
         pr_actions = get_settings().get("GITHUB_ACTION_CONFIG.PR_ACTIONS", ["opened", "reopened", "ready_for_review", "review_requested"])
 
+        # Handle synchronize first so it is not captured by pr_actions
+        if action == "synchronize":
+            push_trigger = get_settings().get(
+                "github_action_config.handle_push_trigger",
+                get_settings().get("github_app.handle_push_trigger", False),
+            )
+            if is_true(push_trigger):
+                pr_url = event_payload.get("pull_request", {}).get("url")
+                if not pr_url:
+                    return
+                before_sha = event_payload.get("before")
+                after_sha = event_payload.get("after")
+                if before_sha is not None and before_sha == after_sha:
+                    return
+                pull_request = event_payload.get("pull_request", {})
+                merge_commit_sha = pull_request.get("merge_commit_sha")
+                ignore_merge_commits = get_settings().get(
+                    "github_action_config.push_trigger_ignore_merge_commits",
+                    get_settings().get("github_app.push_trigger_ignore_merge_commits", True),
+                )
+                if is_true(ignore_merge_commits) and after_sha is not None and after_sha == merge_commit_sha:
+                    get_logger().info("Skipping synchronize: merge commit detected")
+                    return
+                sender_type = event_payload.get("sender", {}).get("type")
+                ignore_bot_commits = get_settings().get(
+                    "github_action_config.push_trigger_ignore_bot_commits",
+                    get_settings().get("github_app.push_trigger_ignore_bot_commits", True),
+                )
+                if is_true(ignore_bot_commits) and sender_type == "Bot":
+                    get_logger().info("Skipping synchronize: bot commit detected")
+                    return
+                push_commands = get_settings().get(
+                    "github_action_config.push_commands",
+                    get_settings().get("github_app.push_commands", []),
+                )
+                if isinstance(push_commands, str):
+                    push_commands = [push_commands]
+                if not push_commands:
+                    get_logger().info("No push_commands configured, skipping synchronize")
+                    return
+                get_settings().config.is_auto_command = True
+                get_settings().pr_description.final_update_message = False
+                get_logger().info(f"Running push commands: {push_commands}")
+                for command in push_commands:
+                    await PRAgent().handle_request(pr_url, command)
+                return
         if action in pr_actions:
             pr_url = event_payload.get("pull_request", {}).get("url")
             if pr_url:

pr_agent/settings/configuration.toml

@@ -235,6 +235,10 @@ publish_as_check_run = false # when true, publish review/description/improve out
 # auto_describe = true  # set as env var in .github/workflows/pr-agent.yaml
 # auto_improve = true   # set as env var in .github/workflows/pr-agent.yaml
 # pr_actions = ['opened', 'reopened', 'ready_for_review', 'review_requested']
+# handle_push_trigger = false  # when true, handle synchronize events using push_commands (falls back to github_app.handle_push_trigger)
+# push_trigger_ignore_bot_commits = true
+# push_trigger_ignore_merge_commits = true
+# push_commands = ['/describe', '/review']  # defaults mirror github_app.push_commands
 
 [github_app]
 # these toggles allows running the github app from custom deployments

tests/unittest/test_github_action_runner_core.py

@@ -107,13 +107,15 @@ class FakeSuggestions(FakeTool):
 
 @pytest.fixture
 def restore_github_settings():
-    """run_action mutates global GITHUB/GITHUB_ACTION_CONFIG settings; snapshot
+    """run_action mutates global GITHUB/GITHUB_ACTION_CONFIG/GITHUB_APP settings; snapshot
     and restore them so these tests don't leak state into others."""
     settings = get_settings()
     had_github = "GITHUB" in settings
     original_github = copy.deepcopy(settings.get("GITHUB", None))
     had_cfg = "GITHUB_ACTION_CONFIG" in settings
     original_cfg = copy.deepcopy(settings.get("GITHUB_ACTION_CONFIG", None))
+    had_app = "GITHUB_APP" in settings
+    original_app = copy.deepcopy(settings.get("GITHUB_APP", None))
     yield
     if had_github:
         settings.set("GITHUB", original_github)
@@ -123,6 +125,28 @@ def restore_github_settings():
         settings.set("GITHUB_ACTION_CONFIG", original_cfg)
     else:
         settings.unset("GITHUB_ACTION_CONFIG", force=True)
+    if had_app:
+        settings.set("GITHUB_APP", original_app)
+    else:
+        settings.unset("GITHUB_APP", force=True)
+
+
+def _write_synchronize_event(tmp_path, before_sha="abc", after_sha="def", merge_commit_sha=None, sender_type="User"):
+    payload = {
+        "action": "synchronize",
+        "before": before_sha,
+        "after": after_sha,
+        "sender": {"type": sender_type},
+        "pull_request": {
+            "url": "https://api.github.com/repos/org/repo/pulls/1",
+            "html_url": "https://github.com/org/repo/pull/1",
+        },
+    }
+    if merge_commit_sha is not None:
+        payload["pull_request"]["merge_commit_sha"] = merge_commit_sha
+    event_path = tmp_path / "event.json"
+    event_path.write_text(json.dumps(payload))
+    return event_path
 
 
 def _write_issue_comment_event(tmp_path, sender_type):
@@ -174,6 +198,133 @@ async def test_issue_comment_from_bot_sender_is_skipped(monkeypatch, tmp_path, r
     assert handled == []  # bot comment skipped; no command handled
 
 
+def _patch_synchronize_deps(monkeypatch, handled, push_commands, handle_push_trigger=True):
+    monkeypatch.setattr(github_action_runner, "apply_repo_settings", lambda pr_url: None)
+    settings = get_settings()
+    monkeypatch.setitem(settings.store["github_app"], "push_commands", list(push_commands))
+    settings.set("github_action_config", {
+        "handle_push_trigger": handle_push_trigger,
+        "push_trigger_ignore_merge_commits": False,
+        "push_trigger_ignore_bot_commits": False,
+    }, merge=False)
+
+    class FakeAgent:
+        async def handle_request(self, url, body, notify=None):
+            handled.append((url, body))
+
+    monkeypatch.setattr(github_action_runner, "PRAgent", FakeAgent)
+
+
+@pytest.mark.asyncio
+async def test_synchronize_event_triggers_push_commands(monkeypatch, tmp_path, restore_github_settings):
+    handled = []
+    _patch_synchronize_deps(monkeypatch, handled, ["/describe", "/improve"])
+    monkeypatch.setenv("GITHUB_EVENT_NAME", "pull_request")
+    monkeypatch.setenv("GITHUB_EVENT_PATH", str(_write_synchronize_event(tmp_path)))
+    monkeypatch.setenv("GITHUB_TOKEN", "token")
+
+    await github_action_runner.run_action()
+
+    assert handled == [
+        ("https://api.github.com/repos/org/repo/pulls/1", "/describe"),
+        ("https://api.github.com/repos/org/repo/pulls/1", "/improve"),
+    ]
+
+
+@pytest.mark.asyncio
+async def test_synchronize_skips_when_push_trigger_disabled(monkeypatch, tmp_path, restore_github_settings):
+    handled = []
+    _patch_synchronize_deps(monkeypatch, handled, ["/describe"], handle_push_trigger=False)
+    monkeypatch.setenv("GITHUB_EVENT_NAME", "pull_request")
+    monkeypatch.setenv("GITHUB_EVENT_PATH", str(_write_synchronize_event(tmp_path)))
+    monkeypatch.setenv("GITHUB_TOKEN", "token")
+
+    await github_action_runner.run_action()
+
+    assert handled == []
+
+
+@pytest.mark.asyncio
+async def test_synchronize_skips_equal_before_after_sha(monkeypatch, tmp_path, restore_github_settings):
+    handled = []
+    _patch_synchronize_deps(monkeypatch, handled, ["/describe"])
+    monkeypatch.setenv("GITHUB_EVENT_NAME", "pull_request")
+    event_path = _write_synchronize_event(tmp_path, before_sha="same", after_sha="same")
+    monkeypatch.setenv("GITHUB_EVENT_PATH", str(event_path))
+    monkeypatch.setenv("GITHUB_TOKEN", "token")
+
+    await github_action_runner.run_action()
+
+    assert handled == []
+
+
+@pytest.mark.asyncio
+async def test_synchronize_event_triggers_push_commands_on_pull_request_target(monkeypatch, tmp_path, restore_github_settings):
+    handled = []
+    _patch_synchronize_deps(monkeypatch, handled, ["/describe", "/improve"])
+    monkeypatch.setenv("GITHUB_EVENT_NAME", "pull_request_target")
+    monkeypatch.setenv("GITHUB_EVENT_PATH", str(_write_synchronize_event(tmp_path)))
+    monkeypatch.setenv("GITHUB_TOKEN", "token")
+
+    await github_action_runner.run_action()
+
+    assert handled == [
+        ("https://api.github.com/repos/org/repo/pulls/1", "/describe"),
+        ("https://api.github.com/repos/org/repo/pulls/1", "/improve"),
+    ]
+
+
+@pytest.mark.asyncio
+async def test_synchronize_skips_merge_commit(monkeypatch, tmp_path, restore_github_settings):
+    handled = []
+    _patch_synchronize_deps(monkeypatch, handled, ["/describe"])
+    settings = get_settings()
+    monkeypatch.setitem(settings.store["github_action_config"], "push_trigger_ignore_merge_commits", True)
+    monkeypatch.setenv("GITHUB_EVENT_NAME", "pull_request")
+    monkeypatch.setenv("GITHUB_EVENT_PATH", str(_write_synchronize_event(
+        tmp_path, before_sha="abc", after_sha="merge123", merge_commit_sha="merge123"
+    )))
+    monkeypatch.setenv("GITHUB_TOKEN", "token")
+
+    await github_action_runner.run_action()
+
+    assert handled == []
+
+
+@pytest.mark.asyncio
+async def test_synchronize_skips_bot_commit(monkeypatch, tmp_path, restore_github_settings):
+    handled = []
+    _patch_synchronize_deps(monkeypatch, handled, ["/describe"])
+    settings = get_settings()
+    monkeypatch.setitem(settings.store["github_action_config"], "push_trigger_ignore_bot_commits", True)
+    monkeypatch.setenv("GITHUB_EVENT_NAME", "pull_request")
+    monkeypatch.setenv("GITHUB_EVENT_PATH", str(_write_synchronize_event(
+        tmp_path, sender_type="Bot"
+    )))
+    monkeypatch.setenv("GITHUB_TOKEN", "token")
+
+    await github_action_runner.run_action()
+
+    assert handled == []
+
+
+@pytest.mark.asyncio
+async def test_synchronize_uses_github_action_config_push_commands(monkeypatch, tmp_path, restore_github_settings):
+    handled = []
+    _patch_synchronize_deps(monkeypatch, handled, ["/review"], handle_push_trigger=True)
+    settings = get_settings()
+    monkeypatch.setitem(settings.store["github_action_config"], "push_commands", ["/describe"])
+    monkeypatch.setenv("GITHUB_EVENT_NAME", "pull_request")
+    monkeypatch.setenv("GITHUB_EVENT_PATH", str(_write_synchronize_event(tmp_path)))
+    monkeypatch.setenv("GITHUB_TOKEN", "token")
+
+    await github_action_runner.run_action()
+
+    assert handled == [
+        ("https://api.github.com/repos/org/repo/pulls/1", "/describe"),
+    ]
+
+
 @pytest.mark.asyncio
 async def test_issue_comment_from_user_is_processed(monkeypatch, tmp_path, restore_github_settings):
     """The bot guard must not over-skip: a human comment is still handled."""