Show exact run URL and add lifecycle comment to wheel promotion (DataDog#23828)

AAraKKe · web-flow · commit 12c11b54b2cf · 2026-05-27T08:34:58.000Z
* Show exact run URL and add lifecycle comment to wheel promotion

- Extend dispatch_workflow with return_run_details so callers can get back the
  new run's html_url instead of a generic recent-runs link.
- ddev dep promote now prints the exact workflow run URL and suppresses noisy
  httpx request logs around the API calls.
- Replace the single success comment in dependency-wheel-promotion.yaml with a
  lifecycle comment that updates on start, success, and failure, scoped per
  (PR, head SHA) via a hidden marker so re-dispatches edit the same comment.

* Harden lifecycle comment chaining and github-script inputs

- Started-comment step now references find_comment.outputs.comment-id (the
  previous version pointed at its own step output, so re-dispatches for the
  same SHA would not have updated the existing comment).
- Pass inputs.head_sha into actions/github-script via env: HEAD_SHA and read
  process.env.HEAD_SHA in the script body, so a hostile workflow_dispatch
  input cannot break out of the JS string literal and execute arbitrary code.

* Type-narrow dispatch_workflow and bail out cleanly on missing run details

- Add Literal[True]/Literal[False] overloads to GitHubManager.dispatch_workflow
  so callers asking for run details get a non-nullable dict back at the type
  level.
- Replace the bare assert in ddev dep promote with an explicit app.abort, run
  the validity check before printing the success message, and keep the success
  output inside the httpx-suppression scope.
- Add ddev/changelog.d/23828.added so the PR-changelog check passes for the
  ddev source changes.
- Lift the github credentials setup into ddev/tests/cli/dep/conftest.py as an
  autouse fixture, hoist the test-side logging import, and add coverage for the
  no-run-details abort path and the failure-path httpx level restoration.
- Match the cleaner api_post.call_args.kwargs form already used in the
  companion test in tests/utils/test_github.py.

* Trim runtime imports and share httpx-debug fixture across promote tests

- Move Any and Literal under TYPE_CHECKING in github.py; they are only used
  inside annotations that PEP 563 keeps as strings, so they have no runtime
  cost. The overload decorator stays at module scope because it runs at class
  definition time.
- Add an httpx_at_debug fixture in tests/cli/dep/conftest.py and use it from
  both httpx-suppression tests so the get-logger/set-DEBUG/restore boilerplate
  lives in one place.

* Type-annotate the new ddev/tests/cli/dep fixtures
diff --git a/.github/workflows/dependency-wheel-promotion.yaml b/.github/workflows/dependency-wheel-promotion.yaml
@@ -27,6 +27,25 @@ jobs:
     - name: Checkout trusted code
       uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
+    - name: Find existing lifecycle comment
+      id: find_comment
+      uses: peter-evans/find-comment@b30e6a3c0ed37e7c023ccd3f1db5c6c0b0c23aad # v4.0.0
+      with:
+        issue-number: ${{ inputs.pr_number }}
+        body-includes: "<!-- dependency-wheel-promotion pr=${{ inputs.pr_number }} sha=${{ inputs.head_sha }} -->"
+
+    - name: Post lifecycle comment (started)
+      id: started_comment
+      uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0
+      with:
+        issue-number: ${{ inputs.pr_number }}
+        comment-id: ${{ steps.find_comment.outputs.comment-id }}
+        edit-mode: replace
+        body: |
+          <!-- dependency-wheel-promotion pr=${{ inputs.pr_number }} sha=${{ inputs.head_sha }} -->
+          Wheel promotion started for commit `${{ inputs.head_sha }}` by @${{ github.actor }}.
+          Workflow run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+
     - name: Checkout PR lockfiles only
       uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       with:
@@ -62,41 +81,57 @@ jobs:
 
     - name: Set dependency-wheel-promotion status to success
       uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
+      env:
+        HEAD_SHA: ${{ inputs.head_sha }}
       with:
         script: |
           await github.rest.repos.createCommitStatus({
             owner: context.repo.owner,
             repo: context.repo.repo,
-            sha: '${{ inputs.head_sha }}',
+            sha: process.env.HEAD_SHA,
             state: 'success',
             context: 'dependency-wheel-promotion',
             description: 'Wheels promoted to stable storage.',
             target_url: `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`,
           });
 
-    - name: Post success comment
-      uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
+    - name: Update lifecycle comment (success)
+      uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0
       with:
-        script: |
-          const runUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;
-          await github.rest.issues.createComment({
-            owner: context.repo.owner,
-            repo: context.repo.repo,
-            issue_number: ${{ inputs.pr_number }},
-            body: `Wheels promoted to stable storage for commit ${{ inputs.head_sha }} by @${context.actor}. [Workflow run](${runUrl}).`,
-          });
+        issue-number: ${{ inputs.pr_number }}
+        comment-id: ${{ steps.started_comment.outputs.comment-id }}
+        edit-mode: replace
+        body: |
+          <!-- dependency-wheel-promotion pr=${{ inputs.pr_number }} sha=${{ inputs.head_sha }} -->
+          Wheels promoted to stable storage for commit `${{ inputs.head_sha }}` by @${{ github.actor }}.
+          Workflow run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
 
     - name: Set dependency-wheel-promotion status to error
       if: failure()
       uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
+      env:
+        HEAD_SHA: ${{ inputs.head_sha }}
       with:
         script: |
           await github.rest.repos.createCommitStatus({
             owner: context.repo.owner,
             repo: context.repo.repo,
-            sha: '${{ inputs.head_sha }}',
+            sha: process.env.HEAD_SHA,
             state: 'error',
             context: 'dependency-wheel-promotion',
             description: 'Wheel promotion failed. Check the Actions tab for details.',
             target_url: `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`,
           });
+
+    - name: Update lifecycle comment (failure)
+      if: failure()
+      uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0
+      with:
+        issue-number: ${{ inputs.pr_number }}
+        comment-id: ${{ steps.started_comment.outputs.comment-id }}
+        edit-mode: replace
+        body: |
+          <!-- dependency-wheel-promotion pr=${{ inputs.pr_number }} sha=${{ inputs.head_sha }} -->
+          Wheel promotion failed for commit `${{ inputs.head_sha }}` by @${{ github.actor }}.
+          Workflow run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+          Check the workflow logs before retrying.
diff --git a/ddev/changelog.d/23828.added b/ddev/changelog.d/23828.added
@@ -0,0 +1 @@
+Print the exact workflow run URL when dispatching `ddev dep promote`, via a new `return_run_details` option on `GitHubManager.dispatch_workflow`.
diff --git a/ddev/src/ddev/cli/dep/promote.py b/ddev/src/ddev/cli/dep/promote.py
@@ -3,6 +3,7 @@
 # Licensed under a 3-clause BSD style license (see LICENSE)
 from __future__ import annotations
 
+import logging
 import re
 from typing import TYPE_CHECKING
 
@@ -39,20 +40,26 @@ def promote(app: Application, pr_url: str):
 
     pr_number = int(match.group(1))
 
-    with app.status(f'Fetching PR #{pr_number} head...'):
-        head_sha, head_ref = app.github.get_pr_head(pr_number)
+    httpx_logger = logging.getLogger('httpx')
+    previous_level = httpx_logger.level
+    httpx_logger.setLevel(logging.WARNING)
+    try:
+        with app.status(f'Fetching PR #{pr_number} head...'):
+            head_sha, head_ref = app.github.get_pr_head(pr_number)
 
-    app.display_info(f'PR #{pr_number} — branch: {head_ref}, SHA: {head_sha}')
+        app.display_info(f'PR #{pr_number}: branch {head_ref}, SHA {head_sha}')
 
-    with app.status('Dispatching promote workflow...'):
-        app.github.dispatch_workflow(
-            workflow_id=PROMOTE_WORKFLOW,
-            ref=PROMOTE_WORKFLOW_REF,
-            inputs={'pr_number': str(pr_number), 'head_sha': head_sha},
-        )
+        with app.status('Dispatching promote workflow...'):
+            run_details = app.github.dispatch_workflow(
+                workflow_id=PROMOTE_WORKFLOW,
+                ref=PROMOTE_WORKFLOW_REF,
+                inputs={'pr_number': str(pr_number), 'head_sha': head_sha},
+                return_run_details=True,
+            )
 
-    runs_url = (
-        f'https://github.com/{app.github.repo_id}/actions/workflows/{PROMOTE_WORKFLOW}?query=event%3Aworkflow_dispatch'
-    )
-    app.display_success(f'Promote workflow dispatched for PR #{pr_number}.')
-    app.display_info(f'Recent runs: {runs_url}')
+        if not run_details:
+            app.abort('Workflow dispatched but no run details were returned.')
+        app.display_success(f'Promote workflow dispatched for PR #{pr_number}.')
+        app.display_info(f'Workflow run: {run_details["html_url"]}')
+    finally:
+        httpx_logger.setLevel(previous_level)
diff --git a/ddev/src/ddev/utils/github.py b/ddev/src/ddev/utils/github.py
@@ -6,9 +6,11 @@
 import json
 from functools import cached_property
 from time import time
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, overload
 
 if TYPE_CHECKING:
+    from typing import Any, Literal
+
     from httpx import Client
 
     from ddev.cli.terminal import BorrowedStatus
@@ -217,12 +219,48 @@ def get_pull_request_labels(self, pr_number: int) -> list[str] | None:
             return None
         return [label['name'] for label in response.json().get('labels', [])]
 
-    def dispatch_workflow(self, workflow_id: str, ref: str, inputs: dict[str, Any]) -> None:
-        """Trigger a workflow_dispatch event."""
-        self.__api_post(
+    @overload
+    def dispatch_workflow(
+        self,
+        workflow_id: str,
+        ref: str,
+        inputs: dict[str, Any],
+        return_run_details: Literal[False] = False,
+    ) -> None: ...
+
+    @overload
+    def dispatch_workflow(
+        self,
+        workflow_id: str,
+        ref: str,
+        inputs: dict[str, Any],
+        return_run_details: Literal[True],
+    ) -> dict[str, Any]: ...
+
+    def dispatch_workflow(
+        self,
+        workflow_id: str,
+        ref: str,
+        inputs: dict[str, Any],
+        return_run_details: bool = False,
+    ) -> dict[str, Any] | None:
+        """Trigger a workflow_dispatch event.
+
+        When ``return_run_details`` is true, request the new run's details from
+        the API and return the parsed JSON response (``workflow_run_id``,
+        ``run_url``, ``html_url``). The default keeps the prior fire-and-forget
+        behavior and returns ``None``.
+        """
+        payload: dict[str, Any] = {'ref': ref, 'inputs': inputs}
+        if return_run_details:
+            payload['return_run_details'] = True
+        response = self.__api_post(
             self.WORKFLOW_DISPATCH_API.format(repo_id=self.repo_id, workflow_id=workflow_id),
-            content=json.dumps({'ref': ref, 'inputs': inputs}),
+            content=json.dumps(payload),
         )
+        if not return_run_details:
+            return None
+        return response.json()
 
     def get_pull_request_comments(self, pr_number: int) -> list[dict]:
         response = self.__api_get(
diff --git a/ddev/tests/cli/dep/conftest.py b/ddev/tests/cli/dep/conftest.py
@@ -0,0 +1,32 @@
+# (C) Datadog, Inc. 2026-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from __future__ import annotations
+
+import logging
+from collections.abc import Generator
+from typing import TYPE_CHECKING
+
+import pytest
+
+if TYPE_CHECKING:
+    from ddev.config.file import ConfigFileWithOverrides
+
+
+@pytest.fixture(autouse=True)
+def configure_github_credentials(config_file: ConfigFileWithOverrides) -> None:
+    """Provide github credentials so commands that touch app.github do not abort."""
+    config_file.model.github = {'user': 'test-user', 'token': 'test-token'}
+    config_file.save()
+
+
+@pytest.fixture
+def httpx_at_debug() -> Generator[logging.Logger, None, None]:
+    """Force the httpx logger to DEBUG and restore its previous level on teardown."""
+    logger = logging.getLogger('httpx')
+    previous_level = logger.level
+    logger.setLevel(logging.DEBUG)
+    try:
+        yield logger
+    finally:
+        logger.setLevel(previous_level)
diff --git a/ddev/tests/cli/dep/test_promote.py b/ddev/tests/cli/dep/test_promote.py
@@ -0,0 +1,79 @@
+# (C) Datadog, Inc. 2026-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+import logging
+
+import pytest
+
+RUN_DETAILS = {
+    'workflow_run_id': 999,
+    'run_url': 'https://api.github.com/repos/DataDog/integrations-core/actions/runs/999',
+    'html_url': 'https://github.com/DataDog/integrations-core/actions/runs/999',
+}
+
+
+def test_promote_dispatches_workflow_and_prints_run_url(ddev, mocker):
+    mocker.patch('ddev.utils.github.GitHubManager.get_pr_head', return_value=('deadbeef', 'feature-branch'))
+    dispatch = mocker.patch('ddev.utils.github.GitHubManager.dispatch_workflow', return_value=RUN_DETAILS)
+
+    result = ddev('dep', 'promote', 'https://github.com/DataDog/integrations-core/pull/12345')
+
+    assert result.exit_code == 0, result.output
+    dispatch.assert_called_once_with(
+        workflow_id='dependency-wheel-promotion.yaml',
+        ref='master',
+        inputs={'pr_number': '12345', 'head_sha': 'deadbeef'},
+        return_run_details=True,
+    )
+    assert 'PR #12345' in result.output
+    assert 'feature-branch' in result.output
+    assert 'deadbeef' in result.output
+    assert RUN_DETAILS['html_url'] in result.output
+    assert 'Recent runs' not in result.output
+    assert 'query=event%3Aworkflow_dispatch' not in result.output
+
+
+def test_promote_invalid_pr_url_aborts(ddev):
+    result = ddev('dep', 'promote', 'https://example.invalid/not-a-pr')
+
+    assert result.exit_code != 0
+    assert 'Could not extract a PR number' in result.output
+
+
+def test_promote_aborts_when_no_run_details_returned(ddev, mocker):
+    mocker.patch('ddev.utils.github.GitHubManager.get_pr_head', return_value=('deadbeef', 'feature-branch'))
+    mocker.patch('ddev.utils.github.GitHubManager.dispatch_workflow', return_value=None)
+
+    result = ddev('dep', 'promote', 'https://github.com/DataDog/integrations-core/pull/12345')
+
+    assert result.exit_code != 0
+    assert 'no run details were returned' in result.output
+    assert 'Promote workflow dispatched' not in result.output
+
+
+def test_promote_suppresses_httpx_logs_and_restores_level(ddev, mocker, httpx_at_debug):
+    captured_levels = []
+
+    def capture_level(*_args, **_kwargs):
+        captured_levels.append(httpx_at_debug.level)
+        return ('deadbeef', 'feature-branch')
+
+    mocker.patch('ddev.utils.github.GitHubManager.get_pr_head', side_effect=capture_level)
+    mocker.patch('ddev.utils.github.GitHubManager.dispatch_workflow', return_value=RUN_DETAILS)
+
+    result = ddev('dep', 'promote', 'https://github.com/DataDog/integrations-core/pull/12345')
+
+    assert result.exit_code == 0, result.output
+    assert captured_levels == [logging.WARNING]
+    assert httpx_at_debug.level == logging.DEBUG
+
+
+def test_promote_restores_httpx_log_level_on_failure(ddev, mocker, httpx_at_debug):
+    """Ensure the finally branch restores the previous httpx logger level even when an API call raises."""
+    mocker.patch('ddev.utils.github.GitHubManager.get_pr_head', side_effect=RuntimeError('boom'))
+    mocker.patch('ddev.utils.github.GitHubManager.dispatch_workflow')
+
+    with pytest.raises(RuntimeError, match='boom'):
+        ddev('dep', 'promote', 'https://github.com/DataDog/integrations-core/pull/12345')
+
+    assert httpx_at_debug.level == logging.DEBUG
diff --git a/ddev/tests/utils/test_github.py b/ddev/tests/utils/test_github.py
@@ -1,6 +1,8 @@
 # (C) Datadog, Inc. 2023-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
+import json
+
 import pytest
 
 from ddev.utils.github import PullRequest
@@ -83,3 +85,46 @@ def test_create_label(self, network_replay, github_manager):
 
         assert label.json()['name'] == 'my_custom_label'
         assert label.json()['color'] == 'ff0000'
+
+
+def test_dispatch_workflow_default_returns_none(github_manager, mocker):
+    """Default dispatch_workflow keeps the prior fire-and-forget behavior."""
+    response = mocker.MagicMock()
+    api_post = mocker.patch('ddev.utils.github.GitHubManager._GitHubManager__api_post', return_value=response)
+
+    result = github_manager.dispatch_workflow(
+        workflow_id='example.yaml',
+        ref='master',
+        inputs={'pr_number': '123', 'head_sha': 'deadbeef'},
+    )
+
+    assert result is None
+    api_post.assert_called_once()
+    payload = json.loads(api_post.call_args.kwargs['content'])
+    assert payload == {'ref': 'master', 'inputs': {'pr_number': '123', 'head_sha': 'deadbeef'}}
+    assert 'return_run_details' not in payload
+
+
+def test_dispatch_workflow_return_run_details_sends_flag_and_returns_json(github_manager, mocker):
+    """When return_run_details is true, the payload includes the flag and the parsed JSON is returned."""
+    run_details = {
+        'workflow_run_id': 42,
+        'run_url': 'https://api.github.com/repos/o/r/actions/runs/42',
+        'html_url': 'https://github.com/o/r/actions/runs/42',
+    }
+    response = mocker.MagicMock()
+    response.json.return_value = run_details
+    api_post = mocker.patch('ddev.utils.github.GitHubManager._GitHubManager__api_post', return_value=response)
+
+    result = github_manager.dispatch_workflow(
+        workflow_id='example.yaml',
+        ref='master',
+        inputs={'pr_number': '123', 'head_sha': 'deadbeef'},
+        return_run_details=True,
+    )
+
+    assert result == run_details
+    payload = json.loads(api_post.call_args.kwargs['content'])
+    assert payload['return_run_details'] is True
+    assert payload['ref'] == 'master'
+    assert payload['inputs'] == {'pr_number': '123', 'head_sha': 'deadbeef'}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Print the exact workflow run URL when dispatching `ddev dep promote`, via a new `return_run_details` option on `GitHubManager.dispatch_workflow`.