Skip to content

feat(github-action)!: Update codex-/return-dispatch (v3.0.3 → v4.0.1) - #137

Open
home-infrastructure-renovate[bot] wants to merge 1 commit into
mainfrom
renovate/codex-return-dispatch-4.x
Open

feat(github-action)!: Update codex-/return-dispatch (v3.0.3 → v4.0.1)#137
home-infrastructure-renovate[bot] wants to merge 1 commit into
mainfrom
renovate/codex-return-dispatch-4.x

Conversation

@home-infrastructure-renovate

@home-infrastructure-renovate home-infrastructure-renovate Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

This PR contains the following updates:

Package Type Update Change
codex-/return-dispatch action major v3.0.3v4.0.1

Release Notes

codex-/return-dispatch (codex-/return-dispatch)

v4.0.1

Compare Source

   🐞 Bug Fixes
    View changes on GitHub

v4.0.0

Compare Source

Github finally added proper support for returning the run ID when dispatching: https://github.blog/changelog/2026-02-19-workflow-dispatch-api-now-returns-run-ids/

This release focuses on using the changes made to the dispatch endpoints, removing the overhead of trawling/polling
for the distinct ID previously required.

⚠️ Breaking changes

Server support
  • Requires github.com or GitHub Enterprise Server 3.21+.
  • On older GHES the dispatch API rejects the return_run_details field with a 400, and the action fails with a message explaining the requirement.
    • If you are on GHES ≤ 3.20, stay on v3.
Removed inputs
Input What to do
distinct_id Remove. Run identification no longer uses an injected ID.
workflow_timeout_seconds Remove. There is no polling to time out.
workflow_job_steps_retry_seconds Remove. There are no retries.
distinct_id is no longer injected into the dispatched workflow's inputs

Your receiving workflow no longer needs the distinct_id:

 on:
   workflow_dispatch:
     inputs:
-      distinct_id:
-        required: true
       custom_inputs:

 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - name: echo distinct ID ${{ inputs.distinct_id }}
-        run: echo "${{ inputs.distinct_id }}"

[!IMPORTANT]
If your receiving workflow declares distinct_id as a required input, v4 dispatches to it will fail because the action no longer sends it. Make it optional or remove it before upgrading.

Migration checklist

  1. Remove distinct_id, workflow_timeout_seconds, and workflow_job_steps_retry_seconds
    from the return-dispatch step.
  2. Remove the distinct_id input and echo step from the receiving workflow (or mark it non-required as a preliminary step)
  3. Optionally narrow token permissions: only actions: write (fine-grained PAT / GitHub App / GITHUB_TOKEN) or repo scope (classic PAT) is needed.

🚀 Features

View changes on GitHub

v4

Compare Source


Configuration

📅 Schedule: (in timezone Europe/Berlin)

  • Branch creation
    • At any time (no schedule defined)
  • Automerge
    • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate.

@home-infrastructure-renovate home-infrastructure-renovate Bot changed the title feat(github-action)!: Update codex-/return-dispatch (v3.0.3 → v4.0.0) feat(github-action)!: Update codex-/return-dispatch (v3.0.3 → v4.0.1) Aug 13, 2026
@home-infrastructure-renovate
home-infrastructure-renovate Bot force-pushed the renovate/codex-return-dispatch-4.x branch from edceb89 to 4e630fd Compare August 13, 2026 00:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants