Merge pull request github#236 from github/deprecate-merge-commit-sha

jasonrudolph · jasonrudolph · commit 159307ca80a1 · 2013-04-25T12:31:18.000-07:00
Explain &amp; deprecate merge_commit_sha
diff --git a/content/index.md b/content/index.md
@@ -39,6 +39,8 @@ objects.
 * `[ ]` `master_branch` becomes `default_branch`.
 * `[ ]` `integrate_branch` on the [repo API](/v3/repos/#get) will no longer be
   returned.
+* `[ ]` `merge_commit_sha` on the [pull request API](/v3/pulls/#get-a-single-pull-request)
+  will no longer be returned.
 * `[ ]` Use the `private` attribute when creating a private repository,
   instead of setting `public` to false.
 * `[ ]` Use JSON to POST to the "repos/:owner/:repo/forks" endpoint, instead of a query string.
diff --git a/content/v3/pulls.md b/content/v3/pulls.md
@@ -63,6 +63,18 @@ base
 <%= headers 200 %>
 <%= json :full_pull %>
 
+### Mergability
+
+Each time the pull request receives new commits, GitHub creates a merge commit
+to _test_ whether the pull request can be automatically merged into the base
+branch. (This _test_ commit is not added to the base branch or the head branch.)
+The `merge_commit_sha` attribute holds the SHA of the _test_ merge commit;
+however, this attribute is [deprecated](/#expected-changes) and is scheduled for
+removal in the next version of the API. The Boolean `mergable` attribute will
+remain to indicate whether the pull request can be automatically merged.
+
+### Alternative Response Formats
+
 Pass the appropriate [media type](/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
 
 ## Create a pull request
