Allows automerging PRs in the 'unstable' state #214
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
As outline in an [issue on octokit](octokit/octokit.net#1763), the `unstable` state is defined as "Failing/pending commit status that is not part of the required status checks. Merging is allowed." Running the "Auto Merge" workflow itself induces an `unstable` state as it is a pending check that is not part of the required status checks. This is different than the `blocked` state which is induced by running one of the required status checks. Either way, a merge will only be possible if all of the required checks have passed and so it should be safe to allow the "Auto Merge" workflow to attempt to merge the PR given an `unstable` state.
| @@ -30,7 +30,7 @@ jobs: | |||
| echo "::set-output name=mergeable_state::$(echo "${payload}" | jq -r -c .mergeable_state)" | |||
|
|
|||
| - name: Merge | |||
| if: ${{ steps.pull_request.outputs.mergeable_state == 'clean' }} | |||
| if: ${{ steps.pull_request.outputs.mergeable_state == 'clean' || steps.pull_request.outputs.mergeable_state == 'unstable' }} | |||
There was a problem hiding this comment.
are there cases where 'clean' can still happen? From your description it seems like it would always be in the 'unstable' state since at this point the auto-merge workflow would be running.
There was a problem hiding this comment.
I think the issue here is that the GitHub API is not consistent in what it returns. I believe there is some sort of race condition wherein sometimes it will return clean and other times it returns unstable. Both should be acceptable.
sophiewigmore
approved these changes
Jan 14, 2021
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
As outlined in an issue on octokit, the
unstablestate is defined as "Failing/pending commit status that is not part of the required status checks. Merging is allowed."Use Cases
Running the "Auto Merge" workflow itself induces an
unstablestate as it is a pending check that is not part of the required status checks. This is different than theblockedstate which is induced by running one of the required status checks. Either way, a merge will only be possible if all of the required checks have passed and so it should be safe to allow the "Auto Merge" workflow to attempt to merge the PR given anunstablestate.Checklist