Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement PullRequest MergeableState field #1763

Closed
ryangribble opened this issue Feb 15, 2018 · 0 comments
Closed

Implement PullRequest MergeableState field #1763

ryangribble opened this issue Feb 15, 2018 · 0 comments
Assignees
@ryangribble
Labels
Type: Feature New feature or request

Comments

@ryangribble
Copy link
Contributor

ryangribble commented Feb 15, 2018 •
edited
Loading

This is currently an undocumented field (likely to be added to docs in the future) but provides very useful information about whether a PR can be merged or not, and what the reasons preventing merge actually are.

This field should be implemented as a new Enum class, using our standard Parameter() property to map to the api string values. In the PullRequest class it will be wrapped by our StringEnum<T> wrapper to guard against the addition of more values upstream. It most likely will need to be declared nullable, as it probably isn't returned in GetAll responses, that only return a subset of PullRequest fields

The following values are possible

dirty: Merge conflict. Merging will be blocked

unknown: Mergeability was not checked yet. Merging will be blocked

blocked: Blocked by a failing/missing required status check.

behind: Head branch is behind the base branch. Only if required status checks is enabled but loose policy is not. Merging will be blocked.

unstable: Failing/pending commit status that is not part of the required status checks. Merging is allowed (yellow box).

has_hooks: GitHub Enterprise only, if a repo has custom pre-receive hooks. Merging is allowed (green box).

clean: No conflicts, everything good. Merging is allowed (green box).

Some references:
octokit/octokit.rb#626
google/go-github#820 (comment)
https://platform.github.community/t/documentation-about-mergeable-state/4259
@ryangribble ryangribble self-assigned this Feb 16, 2018
@ryangribble ryangribble mentioned this issue Feb 16, 2018
Merged
@tibdex tibdex mentioned this issue Nov 23, 2019
Open
@sbrunner sbrunner mentioned this issue Jun 18, 2020
Closed
nhaarman pushed a commit to Label305/AutoRebase that referenced this issue Dec 17, 2020
Don't ignore blocked pull requests
a4a2f6f 
Based on octokit/octokit.net#1763 the
'blocked' state represents "Blocked by a failing/missing required
status check". Since there are no conflicts at this point, a rebase
is possible and might even be able to fix the status checks.
@nhaarman nhaarman mentioned this issue Dec 17, 2020
Merged
ryanmoran pushed a commit to paketo-buildpacks/github-config that referenced this issue Jan 14, 2021
Allows automerging PRs in the 'unstable' state
28bb6a1 
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.
@ryanmoran ryanmoran mentioned this issue Jan 14, 2021
Merged
2 tasks
sophiewigmore pushed a commit to paketo-buildpacks/github-config that referenced this issue Jan 14, 2021
@sophiewigmore
Allows automerging PRs in the 'unstable' state
94af1d7 
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.
ryanmoran pushed a commit to paketo-buildpacks/full-builder that referenced this issue Jan 21, 2021
Allows automerging PRs in the 'unstable' state
9fd72df 
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.
@ryanmoran ryanmoran mentioned this issue Jan 21, 2021
Merged
2 tasks
ryanmoran pushed a commit to paketo-buildpacks/base-builder that referenced this issue Jan 21, 2021
Allows automerging PRs in the 'unstable' state
4807e4b 
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.
@ryanmoran ryanmoran mentioned this issue Jan 21, 2021
Merged
2 tasks
ryanmoran pushed a commit to paketo-buildpacks/tiny-builder that referenced this issue Jan 21, 2021
Allows automerging PRs in the 'unstable' state
267da60 
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.
@ryanmoran ryanmoran mentioned this issue Jan 21, 2021
Merged
2 tasks
@connorjclark connorjclark mentioned this issue Feb 10, 2021
Merged
@Tantalon Tantalon mentioned this issue Feb 25, 2021
Merged
@edbighead edbighead mentioned this issue Apr 7, 2022
Closed
@jakubgs jakubgs mentioned this issue Jul 27, 2022
Closed
@nickfloyd nickfloyd added Type: Feature New feature or request and removed category: feature labels Oct 27, 2022
@carlobeltrame carlobeltrame mentioned this issue Nov 2, 2022
Closed
bluedev41 added a commit to bluedev41/AutoRebase that referenced this issue Dec 22, 2022
@bluedev41
Don't ignore blocked pull requests
351af9b 
Based on octokit/octokit.net#1763 the
'blocked' state represents "Blocked by a failing/missing required
status check". Since there are no conflicts at this point, a rebase
is possible and might even be able to fix the status checks.
@carlocab carlocab mentioned this issue Apr 20, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ryangribble ryangribble

Labels
Type: Feature New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nickfloyd @ryangribble