Don't cancel GHA runs on subsequent push events #9917
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
With our switch to using the GitHub merge queue with speculative merging, it's now possible for us to have two push events to a protected branch (like `main`) within a couple of minutes. If this happens, the eager cancellation rules we have set for the coverage and Neko runs in GHA trigger, causing a spurious build failure to appear in the commit logs, and for the coverage history to be lost for one commit. Instead, we can set the cancel-on-update behaviour to only trigger on PR sync events, not branch-push events.
jakelishman
added
type: qa
|
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the the following people are requested to review this:
|
jakelishman
force-pushed
the
better-gha-cancellation
branch
from
33284ba
to
d772150
Compare
|
I tested this by pushing an empty commit to the branch (and then force-pushed it away again). You can see that the coverage and Neko runs were suitably cancelled, for example here: https://github.com/Qiskit/qiskit-terra/actions/runs/4623222644. |
Pull Request Test Coverage Report for Build 4623231438
💛 - Coveralls |
Eric-Arellano
approved these changes
Apr 6, 2023
mtreinish
approved these changes
Apr 6, 2023
giacomoRanieri
pushed a commit
to giacomoRanieri/qiskit-terra
that referenced
this pull request
Apr 16, 2023
With our switch to using the GitHub merge queue with speculative merging, it's now possible for us to have two push events to a protected branch (like `main`) within a couple of minutes. If this happens, the eager cancellation rules we have set for the coverage and Neko runs in GHA trigger, causing a spurious build failure to appear in the commit logs, and for the coverage history to be lost for one commit. Instead, we can set the cancel-on-update behaviour to only trigger on PR sync events, not branch-push events.
king-p3nguin
pushed a commit
to king-p3nguin/qiskit-terra
that referenced
this pull request
May 22, 2023
With our switch to using the GitHub merge queue with speculative merging, it's now possible for us to have two push events to a protected branch (like `main`) within a couple of minutes. If this happens, the eager cancellation rules we have set for the coverage and Neko runs in GHA trigger, causing a spurious build failure to appear in the commit logs, and for the coverage history to be lost for one commit. Instead, we can set the cancel-on-update behaviour to only trigger on PR sync events, not branch-push events.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
With our switch to using the GitHub merge queue with speculative merging, it's now possible for us to have two push events to a protected branch (like
main) within a couple of minutes. If this happens, the eager cancellation rules we have set for the coverage and Neko runs in GHA trigger, causing a spurious build failure to appear in the commit logs, and for the coverage history to be lost for one commit.Instead, we can set the cancel-on-update behaviour to only trigger on PR sync events, not branch-push events.
Details and comments
We also likely want to set the workflows to only trigger on pushes to Qiskit repos so users' notifications don't get spammed, and we're not just burning the planet running unnecessary CI, but that's a separate logical change.