Skip to content

Commit 019a071

Browse files
jasonrudolphjasonrudolph
committed
Announce deprecation of merge_commit_sha
1 parent 74e3fa7 commit 019a071

File tree

7 files changed

+357
-21
lines changed

7 files changed

+357
-21
lines changed

‎changes.atom‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,40 @@
22
<feed xmlns="http://www.w3.org/2005/Atom">
33
<id>http://developer.github.com/</id>
44
<title>GitHub API Changes</title>
5-
<updated>2013-04-24T06:00:00Z</updated>
5+
<updated>2013-04-25T06:00:00Z</updated>
66
<link rel="alternate" href="http://developer.github.com/" />
77
<link rel="self" href="http://developer.github.com/changes.atom" />
88
<author>
99
<name>technoweenie</name>
1010
<uri>https://github.com/technoweenie</uri>
1111
</author>
12+
<entry>
13+
<id>tag:developer.github.com,2013-04-25:/changes/2013-04-25-deprecating-merge-commit-sha/</id>
14+
<title type="html">Deprecating a Confusing Attribute in the Pull Request API</title>
15+
<published>2013-04-25T06:00:00Z</published>
16+
<updated>2013-04-25T06:00:00Z</updated>
17+
<author>
18+
<name>jasonrudolph</name>
19+
<uri>https://github.com/technoweenie</uri>
20+
</author>
21+
<link rel="alternate" href="http://developer.github.com/changes/2013-04-25-deprecating-merge-commit-sha/" />
22+
<content type="html">&lt;p&gt;When you get the details for a Pull Request from the API, the
23+
&lt;a href="/v3/pulls/#get-a-single-pull-request"&gt;response&lt;/a&gt; provides everything there is to
24+
know about that Pull Request. In addition to the useful information provided in
25+
the API response, the JSON also includes the &lt;code&gt;merge_commit_sha&lt;/code&gt; attribute. This
26+
attribute is a frequent source of misunderstanding, and we aim to remove the
27+
confusion.&lt;/p&gt;
28+
29+
&lt;p&gt;To help current API consumers, we’ve &lt;a href="/v3/pulls/#mergability"&gt;documented the
30+
attribute&lt;/a&gt; for improved understanding.&lt;/p&gt;
31+
32+
&lt;p&gt;To protect future API consumers from this confusion, we have
33+
&lt;a href="/#expected-changes"&gt;deprecated&lt;/a&gt; the &lt;code&gt;merge_commit_sha&lt;/code&gt; attribute, and we will
34+
remove it in the next major version of the API.&lt;/p&gt;
35+
36+
&lt;p&gt;As always, if you have any questions or feedback, please drop us a line at
37+
&lt;a href="mailto:support@github.com?subject=Deprecating%20merge_commit_sha"&gt;support@github.com&lt;/a&gt;.&lt;/p&gt;</content>
38+
</entry>
1239
<entry>
1340
<id>tag:developer.github.com,2013-04-24:/changes/2013-04-24-user-agent-required/</id>
1441
<title type="html">User Agent now mandatory</title>

‎changes/2013-04-25-deprecating-merge-commit-sha/index.html‎

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,259 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5+
<meta http-equiv="Content-Language" content="en-us" />
6+
<meta http-equiv="imagetoolbar" content="false" />
7+
<meta name="MSSmartTagsPreventParsing" content="true" />
8+
<title>Deprecating a Confusing Attribute in the Pull Request API</title>
9+
<link rel="alternate" type="application/atom+xml" title="API Changes" href="/changes.atom" />
10+
<link href="/css/reset.css" rel="stylesheet" type="text/css" />
11+
<link href="/css/960.css" rel="stylesheet" type="text/css" />
12+
<link href="/css/uv_active4d.css" rel="stylesheet" type="text/css" />
13+
<link href="/shared/css/documentation.css" media="screen" rel="stylesheet" type="text/css">
14+
<link href="/shared/css/pygments.css" media="screen" rel="stylesheet" type="text/css">
15+
<script src="/shared/js/jquery.js" type="text/javascript"></script>
16+
<script src="/shared/js/documentation.js" type="text/javascript"></script>
17+
</head>
18+
<body class="api">
19+
<div id="header-wrapper">
20+
<div id="header">
21+
<div>
22+
<a class="logo" href="/"><img src="/images/logo_developer.png" height="45" alt="GitHub:Developer" /></a>
23+
<ul class="nav">
24+
<li class="api-status"></li>
25+
<li><a href="/v3/">API v3</a></li>
26+
<li><a href="/changes/">Changes</a></li>
27+
<li><a
28+
href="https://github.com/contact">Support</a></li>
29+
<li><a href="/changes.atom">
30+
<img src="/images/feed-icon-28x28.png" width="16" height="16" alt="GitHub API Changes Feed" />
31+
</a></li>
32+
</ul>
33+
</div>
34+
</div><!-- #header -->
35+
</div><!-- #header-wrapper -->
36+
37+
<div id="wrapper">
38+
<div class="content">
39+
<div class="change" id="/changes/2013-04-25-deprecating-merge-commit-sha/">
40+
<h2 class="title">
41+
<a href="/changes/2013-04-25-deprecating-merge-commit-sha/">Deprecating a Confusing Attribute in the Pull Request API</a>
42+
</h2>
43+
44+
<div class="meta">
45+
<div class="who_when">
46+
<img height="16" width="16" src="https://secure.gravatar.com/avatar/592e1e6f041f9a4ec51846fd82013aea?s=20&d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png" />
47+
<span class="author vcard fn">
48+
<a href="https://github.com/jasonrudolph">jasonrudolph</a>
49+
</span>
50+
<span class="published">
51+
April 25, 2013
52+
53+
</span>
54+
</div>
55+
</div>
56+
57+
58+
<p>When you get the details for a Pull Request from the API, the
59+
<a href="/v3/pulls/#get-a-single-pull-request">response</a> provides everything there is to
60+
know about that Pull Request. In addition to the useful information provided in
61+
the API response, the JSON also includes the <code>merge_commit_sha</code> attribute. This
62+
attribute is a frequent source of misunderstanding, and we aim to remove the
63+
confusion.</p>
64+
65+
<p>To help current API consumers, we’ve <a href="/v3/pulls/#mergability">documented the
66+
attribute</a> for improved understanding.</p>
67+
68+
<p>To protect future API consumers from this confusion, we have
69+
<a href="/#expected-changes">deprecated</a> the <code>merge_commit_sha</code> attribute, and we will
70+
remove it in the next major version of the API.</p>
71+
72+
<p>As always, if you have any questions or feedback, please drop us a line at
73+
<a href="mailto:support@github.com?subject=Deprecating%20merge_commit_sha">support@github.com</a>.</p>
74+
</div>
75+
76+
</div>
77+
78+
<div id="js-sidebar" class="sidebar-shell">
79+
<div class="js-toggle-list sidebar-module expandable">
80+
<ul>
81+
<li class="js-topic">
82+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/">Overview</a></h3>
83+
<ul class="js-guides">
84+
<li><a href="/v3/oauth/">OAuth</a></li>
85+
<li><a href="/v3/meta/">Meta</a></li>
86+
<li><a href="/v3/media/">Media Types</a></li>
87+
<li><a href="/v3/libraries/">Libraries</a></li>
88+
</ul>
89+
</li>
90+
<li class="js-topic">
91+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/guides/">Guides</a></h3>
92+
<ul class="js-guides">
93+
<li><a href="/guides/getting-started/">Getting Started</a></li>
94+
<li><a href="/guides/basics-of-authentication/">Basics of Authentication</a></li>
95+
<li><a href="/guides/rendering-data-as-graphs/">Rendering Data as Graphs</a></li>
96+
</ul>
97+
</li>
98+
<li class="js-topic">
99+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/activity/">Activity</a></h3>
100+
<ul class="js-guides">
101+
<li><a href="/v3/activity/events/">Events</a></li>
102+
<li><a href="/v3/activity/events/types/">Event Types</a></li>
103+
<li><a href="/v3/activity/notifications/">Notifications</a></li>
104+
<li><a href="/v3/activity/starring/">Starring</a></li>
105+
<li><a href="/v3/activity/watching/">Watching</a></li>
106+
</ul>
107+
</li>
108+
<li class="js-topic">
109+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/gists/">Gists</a></h3>
110+
<ul class="js-guides">
111+
<li><a href="/v3/gists/comments/">Comments</a></li>
112+
</ul>
113+
</li>
114+
<li class="js-topic">
115+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/git/">Git Data</a></h3>
116+
<ul class="js-guides">
117+
<li><a href="/v3/git/blobs/">Blobs</a></li>
118+
<li><a href="/v3/git/commits/">Commits</a></li>
119+
<li><a href="/v3/git/refs/">References</a></li>
120+
<li><a href="/v3/git/tags/">Tags</a></li>
121+
<li><a href="/v3/git/trees/">Trees</a></li>
122+
</ul>
123+
</li>
124+
<li class="js-topic">
125+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/issues/">Issues</a></h3>
126+
<ul class="js-guides">
127+
<li><a href="/v3/issues/assignees/">Assignees</a></li>
128+
<li><a href="/v3/issues/comments/">Comments</a></li>
129+
<li><a href="/v3/issues/events/">Events</a></li>
130+
<li><a href="/v3/issues/labels/">Labels</a></li>
131+
<li><a href="/v3/issues/milestones/">Milestones</a></li>
132+
</ul>
133+
</li>
134+
<li class="js-topic">
135+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/orgs/">Orgs</a></h3>
136+
<ul class="js-guides">
137+
<li><a href="/v3/orgs/members/">Members</a></li>
138+
<li><a href="/v3/orgs/teams/">Teams</a></li>
139+
</ul>
140+
</li>
141+
<li class="js-topic">
142+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/pulls/">Pull Requests</a></h3>
143+
<ul class="js-guides">
144+
<li><a href="/v3/pulls/comments/">Review Comments</a></li>
145+
</ul>
146+
</li>
147+
<li class="js-topic">
148+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/repos/">Repositories</a></h3>
149+
<ul class="js-guides">
150+
<li><a href="/v3/repos/collaborators/">Collaborators</a></li>
151+
<li><a href="/v3/repos/comments/">Comments</a></li>
152+
<li><a href="/v3/repos/commits/">Commits</a></li>
153+
<li><a href="/v3/repos/contents/">Contents</a></li>
154+
<li><a href="/v3/repos/downloads/">Downloads</a></li>
155+
<li><a href="/v3/repos/forks/">Forks</a></li>
156+
<li><a href="/v3/repos/keys/">Keys</a></li>
157+
<li><a href="/v3/repos/hooks/">Hooks</a></li>
158+
<li><a href="/v3/repos/merging/">Merging</a></li>
159+
<li><a href="/v3/repos/statuses/">Statuses</a></li>
160+
</ul>
161+
</li>
162+
<li class="js-topic">
163+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/users/">Users</a></h3>
164+
<ul class="js-guides">
165+
<li><a href="/v3/users/emails/">Emails</a></li>
166+
<li><a href="/v3/users/followers/">Followers</a></li>
167+
<li><a href="/v3/users/keys/">Keys</a></li>
168+
</ul>
169+
</li>
170+
<li class="js-topic">
171+
<h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/search/">Search</a></h3>
172+
<ul class="js-guides">
173+
<li><a href="/v3/search/#search-issues">Issues</a></li>
174+
<li><a href="/v3/search/#search-repositories">Repositories</a></li>
175+
<li><a href="/v3/search/#search-users">Users</a></li>
176+
<li><a href="/v3/search/#email-search">Email</a></li>
177+
</ul>
178+
</li>
179+
<li class="js-guides"><h3><a href="/v3/gitignore/">Gitignore</a></h3></li>
180+
<li class="js-guides"><h3><a href="/v3/markdown/">Markdown</a></h3></li>
181+
</ul>
182+
</div> <!-- /sidebar-module -->
183+
<div class="sidebar-module">
184+
<p>This website is a <a href="https://github.com/github/developer.github.com" target="_blank">public GitHub repository</a>. Please help us by forking the project and adding to it.</p>
185+
</div>
186+
</div><!-- /sidebar-shell -->
187+
188+
</div><!-- #wrapper -->
189+
190+
<div id="footer" >
191+
<div class="upper_footer">
192+
<div class="footer_inner clearfix">
193+
194+
<ul class="footer_nav">
195+
<h4>GitHub</h4>
196+
<li><a href="https://github.com/about">About</a></li>
197+
<li><a href="https://github.com/blog">Blog</a></li>
198+
<li><a href="https://github.com/features">Features</a></li>
199+
<li><a href="https://github.com/contact">Contact &amp; Support</a></li>
200+
<li><a href="https://github.com/training">Training</a></li>
201+
<li><a href="http://status.github.com/">Site Status</a></li>
202+
</ul>
203+
204+
<ul class="footer_nav">
205+
<h4>Tools</h4>
206+
<li><a href="http://mac.github.com/">GitHub for Mac</a></li>
207+
<li><a href="http://mobile.github.com/">Issues for iPhone</a></li>
208+
<li><a href="https://gist.github.com">Gist: Code Snippets</a></li>
209+
<li><a href="http://enterprise.github.com/">GitHub Enterprise</a></li>
210+
<li><a href="http://jobs.github.com/">Job Board</a></li>
211+
</ul>
212+
213+
<ul class="footer_nav">
214+
<h4>Extras</h4>
215+
<li><a href="http://shop.github.com/">GitHub Shop</a></li>
216+
<li><a href="http://octodex.github.com/">The Octodex</a></li>
217+
</ul>
218+
219+
<ul class="footer_nav">
220+
<h4>Documentation</h4>
221+
<li><a href="http://help.github.com/">GitHub Help</a></li>
222+
<li><a href="http://developer.github.com/">Developer API</a></li>
223+
<li><a href="http://github.github.com/github-flavored-markdown/">GitHub Flavored Markdown</a></li>
224+
<li><a href="http://pages.github.com/">GitHub Pages</a></li>
225+
</ul>
226+
227+
</div><!-- /.site -->
228+
</div><!-- /.upper_footer -->
229+
230+
<div class="lower_footer">
231+
<ul class="footer-cell">
232+
<li><a href="http://help.github.com/terms-of-service/">Terms of Service</a></li>
233+
<li><a href="http://help.github.com/privacy-policy/">Privacy</a></li>
234+
<li><a href="http://help.github.com/security/">Security</a></li>
235+
</ul>
236+
237+
<span class="footer-cell">
238+
<a href="https://github.com" class="mega-icon mega-icon-invertocat"></a>
239+
</span>
240+
241+
<span class="footer-cell">&copy; <span class="js-year">2013</span> GitHub, Inc. All rights reserved.</span>
242+
</div>
243+
244+
</div><!-- /#footer -->
245+
<script type="text/javascript">
246+
var _gauges = _gauges || [];
247+
(function() {
248+
var t = document.createElement('script');
249+
t.type = 'text/javascript';
250+
t.async = true;
251+
t.id = 'gauges-tracker';
252+
t.setAttribute('data-site-id', '4f2038e0cb25bc1b55000003');
253+
t.src = '//secure.gaug.es/track.js';
254+
var s = document.getElementsByTagName('script')[0];
255+
s.parentNode.insertBefore(t, s);
256+
})();
257+
</script>
258+
</body>
259+
</html>

‎changes/index.html‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,41 @@
3838
<div class="content">
3939
<h1 id="api-changes">API Changes</h1>
4040

41+
<div class="change" id="/changes/2013-04-25-deprecating-merge-commit-sha/">
42+
<h2 class="title">
43+
<a href="/changes/2013-04-25-deprecating-merge-commit-sha/">Deprecating a Confusing Attribute in the Pull Request API</a>
44+
</h2>
45+
46+
<div class="meta">
47+
<div class="who_when">
48+
<img height="16" width="16" src="https://secure.gravatar.com/avatar/592e1e6f041f9a4ec51846fd82013aea?s=20&amp;d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png"><span class="author vcard fn">
49+
<a href="https://github.com/jasonrudolph">jasonrudolph</a>
50+
</span>
51+
<span class="published">
52+
April 25, 2013
53+
54+
</span>
55+
</div>
56+
</div>
57+
58+
<p>When you get the details for a Pull Request from the API, the
59+
<a href="/v3/pulls/#get-a-single-pull-request">response</a> provides everything there is to
60+
know about that Pull Request. In addition to the useful information provided in
61+
the API response, the JSON also includes the <code>merge_commit_sha</code> attribute. This
62+
attribute is a frequent source of misunderstanding, and we aim to remove the
63+
confusion.</p>
64+
65+
<p>To help current API consumers, we’ve <a href="/v3/pulls/#mergability">documented the
66+
attribute</a> for improved understanding.</p>
67+
68+
<p>To protect future API consumers from this confusion, we have
69+
<a href="/#expected-changes">deprecated</a> the <code>merge_commit_sha</code> attribute, and we will
70+
remove it in the next major version of the API.</p>
71+
72+
<p>As always, if you have any questions or feedback, please drop us a line at
73+
<a href="mailto:support@github.com?subject=Deprecating%20merge_commit_sha">support@github.com</a>.</p>
74+
</div>
75+
4176
<div class="change" id="/changes/2013-04-24-user-agent-required/">
4277
<h2 class="title">
4378
<a href="/changes/2013-04-24-user-agent-required/">User Agent now mandatory</a>

‎index.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ <h4 id="expected-changes">Expected Changes</h4>
8585
<code>[ ]</code> <code>integrate_branch</code> on the <a href="/v3/repos/#get">repo API</a> will no longer be
8686
returned.</li>
8787
<li>
88+
<code>[ ]</code> <code>merge_commit_sha</code> on the <a href="/v3/pulls/#get-a-single-pull-request">pull request API</a>
89+
will no longer be returned.</li>
90+
<li>
8891
<code>[ ]</code> Use the <code>private</code> attribute when creating a private repository,
8992
instead of setting <code>public</code> to false.</li>
9093
<li>

0 commit comments

Comments
 (0)