Skip to content

BREAKING CHANGE(github-action): Update Codex-/await-remote-run action v2.1.0 → v3.0.0 - #3329

Open
truecharts-admin wants to merge 1 commit into
mainfrom
renovate/githubactions-codex-await-remote-run-3.0.x
Open

BREAKING CHANGE(github-action): Update Codex-/await-remote-run action v2.1.0 → v3.0.0#3329
truecharts-admin wants to merge 1 commit into
mainfrom
renovate/githubactions-codex-await-remote-run-3.0.x

Conversation

@truecharts-admin

Copy link
Copy Markdown
Contributor

This PR contains the following updates:

Package Type Update Change
Codex-/await-remote-run action major 3dbfaafbb04140

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


Release Notes

Codex-/await-remote-run (Codex-/await-remote-run)

v3.0.0

Compare Source

v3 now more broadly applies the usage of etags, reducing the number of requests that contribute to usage limits, and also brings
improvements driven by requests from the community (and probably organisations using it in a trench coat).

Await specific jobs

Thanks for requesting this, @​jbelien (#​212)

The new jobs input awaits named jobs within the run rather than the run itself, one name per line.
Useful when the remote run continues past the part you actually need, such as gating on build while its deploy carries on.

- uses: Codex-/await-remote-run@v3
  with:
    token: ${{ github.token }}
    repo: repository-name
    owner: repository-owner
    run_id: ${{ steps.return_dispatch.outputs.run_id }}
    jobs: |
      build

Resolves once every listed job has concluded with success, leaving the rest of the run in flight. Any other conclusion, skipped
included, fails immediately. Names must match what GitHub reports rather than the workflow's job key, so a matrix job is build (ubuntu-latest, 20) and a reusable workflow call is build / inner-job-name. A name that never matched fails once the run concludes,
listing every job the run did produce.

Cancel the remote run

Thanks for requesting this, @​oskar-s9s (#​215)

Timing out previously left the remote run going, which is a problem when your workflow then tears down something that run depends on.
Set cancel_timeout_seconds to request cancellation once that much time has elapsed:

- uses: Codex-/await-remote-run@v3
  with:
    token: ${{ secrets.TOKEN }} # Cancelling is a write, so not GITHUB_TOKEN
    repo: repository-name
    owner: repository-owner
    run_id: ${{ steps.return_dispatch.outputs.run_id }}
    run_timeout_seconds: 300
    cancel_timeout_seconds: 240

It must be less than run_timeout_seconds, the difference being how long the action keeps polling to observe the resulting cancelled
conclusion. Combined with jobs, an awaited job failing also cancels the run, as it can no longer succeed. A run whose awaited jobs all
succeeded is never cancelled.

Cancellation is a write and GITHUB_TOKEN cannot be granted Actions write on another repository, so this input always needs a PAT with
Actions write.

Fewer requests against your rate limit

The etag handling was rewritten as a fetch wrapper around the Octokit client, so every request the action makes is now conditional and a
304 costs nothing against the primary rate limit. Previously only the run state fetch was covered. The wrapper preserves any proxy fetch
@actions/github resolved, so self-hosted runners behind a proxy keep working.

Upgrading from v2

There are no intended breaking changes. Bumping the tag should be sufficient. Two behaviours changes worth noting:

  • Failure diagnostics enumerate every unsuccessful job, not only those concluding failure, so a cancelled or timed_out job now gets reported. skipped jobs are excluded as they bury the causal failure.
  • The jobs listing is paginated, so a run with more than 100 jobs no longer reports a truncated set.

Cancellation and awaiting jobs are both opt-in. Leave both inputs unset and the action behaves as it did in v2.


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

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.

2 participants