Skip to content

BREAKING CHANGE(github-action): Update codex-/return-dispatch action v3.0.3 → v4.0.0 - #3006

Merged
alfi0812 merged 1 commit into
mainfrom
renovate/githubactions-codex-return-dispatch-4.0.x
Aug 2, 2026
Merged

BREAKING CHANGE(github-action): Update codex-/return-dispatch action v3.0.3 → v4.0.0#3006
alfi0812 merged 1 commit into
mainfrom
renovate/githubactions-codex-return-dispatch-4.0.x

Conversation

@truecharts-admin

@truecharts-admin truecharts-admin commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

This PR contains the following updates:

Package Type Update Change
codex-/return-dispatch action major 08365b62e404d4

Add the preset :preserveSemverRanges to your config if you don't want to pin your dependencies.


Release Notes

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

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


Configuration

📅 Schedule: (UTC)

  • 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 Renovate Bot.

@Crow-Control Crow-Control left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto approved automated PR

@truecharts-admin truecharts-admin changed the title BREAKING CHANGE(github-action): Update codex-/return-dispatch action v3.0.2 → v4.0.0 BREAKING CHANGE(github-action): Update codex-/return-dispatch action v3.0.3 → v4.0.0 Aug 1, 2026
@truecharts-admin
truecharts-admin force-pushed the renovate/githubactions-codex-return-dispatch-4.0.x branch from 85ac5c0 to 70c3c4c Compare August 1, 2026 03:30
@alfi0812
alfi0812 merged commit df31e38 into main Aug 2, 2026
6 checks passed
@alfi0812
alfi0812 deleted the renovate/githubactions-codex-return-dispatch-4.0.x branch August 2, 2026 07:47
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.

3 participants