Explain & deprecate merge_commit_sha#236
Conversation
The merge_commit_sha is often misunderstood. It is internal GitHub plumbing that just happens to be part of the public API. Explain it (to reduce the confusion for the current version of the API), and announce plans to remove it from the next version of the API.
There was a problem hiding this comment.
I would consider merging (heh) a few of the sentences for clarity:
The Boolean
mergableattribute indicates whether the pull request can be automatically merged, while themerge_commit_shaattribute holds the SHA of the test merge commit. However, however, themerge_commit_shaattribute is deprecated and is scheduled for removal in the next version of the API.
Alternative:
(This test commit is not added to the base branch or the head branch.) The
merge_commit_shaattribute holds the SHA of the test merge commit; however, this attribute is deprecated and is scheduled for removal in the next version of the API. The Booleanmergableattribute will remain to indicate whether the pull request can be automatically merged.
Thanks to @gjtorikian for the suggestion.
|
👍 We can't guarantee the stability of this property, since it changes every time the pull request head or base is updated. Once changed, the merge commit sha is available for git-gc cleanup, meaning the SHA may not even exist when someone looks for it. |
Explain & deprecate merge_commit_sha
Rough draft of Ent API shift
3 participants
The
merge_commit_shais often misunderstood. It is internal GitHub plumbing that just happens to be part of the public API. In this PR, we: