Skip to content

Commit 2fa10cb

Browse files
jasonrudolphjasonrudolph
committed
P U B L I S H 🚀
1 parent 82e35e2 commit 2fa10cb

File tree

104 files changed

+1241
-190
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+1241
-190
lines changed

‎changes.atom‎

Lines changed: 100 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,93 @@
22
<feed xmlns="http://www.w3.org/2005/Atom">
33
<id>http://developer.github.com/</id>
44
<title>GitHub API Changes</title>
5-
<updated>2014-01-07T05:00:00Z</updated>
5+
<updated>2014-01-09T05: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,2014-01-09:/changes/2014-01-09-preview-the-new-deployments-api/</id>
14+
<title type="html">Preview the New Deployments API</title>
15+
<published>2014-01-09T05:00:00Z</published>
16+
<updated>2014-01-09T05:00:00Z</updated>
17+
<author>
18+
<name>atmos</name>
19+
<uri>https://github.com/technoweenie</uri>
20+
</author>
21+
<link rel="alternate" href="http://developer.github.com/changes/2014-01-09-preview-the-new-deployments-api/" />
22+
<content type="html">&lt;p&gt;Today we’re excited to announce a &lt;a href="/v3/repos/deployments/"&gt;Deployments API&lt;/a&gt;. We ship a lot of
23+
software at GitHub: web, mobile, and native. For the last few years, we’ve been
24+
driving our deployments from our &lt;a href="https://speakerdeck.com/jnewland/chatops"&gt;ChatOps tooling&lt;/a&gt; and we’ve learned a
25+
lot. The Deployments API is a generalization of the approach that we’ve been
26+
taking, and we’re really excited to see what our users and integrations start
27+
building around it.&lt;/p&gt;
28+
29+
&lt;p&gt;Deployments are a new model in the GitHub ecosystem. We don’t have any UI
30+
components currently, and deployments are intended to be used exclusively by
31+
tooling. If you’re familiar with the Status API, you know that it allows
32+
various tools to report on the status of a commit (e.g., the progress of an
33+
attempt to perform a build at a particular commit). The Status API doesn’t
34+
perform the build; it just reports the results. Much like the Status API, we
35+
won’t be doing actual deployments for you. Instead, the API provides a way for
36+
you to track the status of your deployments. We’re hoping to provide
37+
consistency across the various type of release processes, regardless of the
38+
underlying steps involved with getting your code built or shipped to your
39+
servers.&lt;/p&gt;
40+
41+
&lt;h2 id="highlights"&gt;Highlights&lt;/h2&gt;
42+
43+
&lt;h3 id="automatic-merging"&gt;Automatic Merging&lt;/h3&gt;
44+
45+
&lt;p&gt;The system can auto-merge the default branch for the repository if the
46+
requested deployment ref is behind the default branch. On active projects it’s
47+
easy to fall behind, so let automation watch your back.&lt;/p&gt;
48+
49+
&lt;h3 id="commit-status-integration"&gt;Commit Status Integration&lt;/h3&gt;
50+
51+
&lt;p&gt;By default, the system rejects deployment requests for repositories that have
52+
commit statuses but don’t have a green build for the deployment ref. This can
53+
be bypassed, but is useful in cases where continuous integration is being used.&lt;/p&gt;
54+
55+
&lt;h3 id="force-deployments"&gt;Force Deployments&lt;/h3&gt;
56+
57+
&lt;p&gt;Sometimes the world crashes down on you, and you need to just get the code out
58+
the door. Forced deployments bypass any commit status checks or ahead/behind
59+
checks in the repository.&lt;/p&gt;
60+
61+
&lt;h3 id="deployment-statuses"&gt;Deployment Statuses&lt;/h3&gt;
62+
63+
&lt;p&gt;Different deployment systems can update the status of a deployment to be
64+
&lt;code&gt;pending&lt;/code&gt;, &lt;code&gt;success&lt;/code&gt;, &lt;code&gt;failure&lt;/code&gt;, or &lt;code&gt;error&lt;/code&gt;. There’s also a field for linking
65+
to deployment output.&lt;/p&gt;
66+
67+
&lt;h3 id="events"&gt;Events&lt;/h3&gt;
68+
69+
&lt;p&gt;Both Deployments and Deployment Statuses trigger events on GitHub. 3rd party
70+
integrations can listen for these events via &lt;a href="/v3/repos/hooks/"&gt;webhooks&lt;/a&gt; and choose
71+
whether or not to actually deploy the repository that the event was created for.&lt;/p&gt;
72+
73+
&lt;h2 id="preview-period"&gt;Preview Period&lt;/h2&gt;
74+
75+
&lt;p&gt;We’re making this new API available today for developers to
76+
&lt;a href="/v3/repos/deployments/#preview-mode"&gt;preview&lt;/a&gt;. We think developers and existing integrations are
77+
going to love it, but we want to &lt;a href="https://github.com/contact?form%5Bsubject%5D=Deployments+API"&gt;get your feedback&lt;/a&gt; before we declare
78+
the Deployments API “final” and “unchangeable.” We expect the preview period to
79+
last for roughly 60-90 days.&lt;/p&gt;
80+
81+
&lt;p&gt;As we discover opportunities to improve the API during the preview period, we
82+
may ship changes that break clients using the preview version of the API. We
83+
want to iterate quickly. To do so, we will announce any changes here (on the
84+
developer blog), but we will not provide any advance notice.&lt;/p&gt;
85+
86+
&lt;p&gt;At the end of preview period, the Deployments API will become an official
87+
component of GitHub API v3. At that point, the new Deployments API will be
88+
stable and suitable for production use.&lt;/p&gt;
89+
90+
</content>
91+
</entry>
1292
<entry>
1393
<id>tag:developer.github.com,2014-01-07:/changes/2014-01-07-upcoming-change-to-default-media-type/</id>
1494
<title type="html">Upcoming Change to Default Media Type</title>
@@ -703,6 +783,25 @@ curl -u defunkt https://api.github.com/feeds
703783

704784
&lt;p&gt;If you have any questions or feedback, &lt;a href="https://github.com/contact?form%5Bsubject%5D=Feeds%20API"&gt;please drop us a line&lt;/a&gt;.&lt;/p&gt;
705785

786+
</content>
787+
</entry>
788+
<entry>
789+
<id>tag:developer.github.com,2013-05-06:/changes/2013-05-06-create-update-delete-individual-files/</id>
790+
<title type="html">Create, update, and delete individual files</title>
791+
<published>2013-05-06T04:00:00Z</published>
792+
<updated>2013-05-06T04:00:00Z</updated>
793+
<author>
794+
<name>ymendel</name>
795+
<uri>https://github.com/technoweenie</uri>
796+
</author>
797+
<link rel="alternate" href="http://developer.github.com/changes/2013-05-06-create-update-delete-individual-files/" />
798+
<content type="html">&lt;p&gt;We’re following in the footsteps of GitHub.com’s ability to &lt;a href="https://github.com/blog/143-inline-file-editing"&gt;edit&lt;/a&gt; and
799+
&lt;a href="https://github.com/blog/1327-creating-files-on-github"&gt;create&lt;/a&gt; files in your web browser. Starting today, the
800+
&lt;a href="/v3/repos/contents/"&gt;Repository Contents API&lt;/a&gt; will let you easily &lt;a href="/v3/repos/contents/#create-a-file"&gt;create&lt;/a&gt;, &lt;a href="/v3/repos/contents/#update-a-file"&gt;update&lt;/a&gt;, and even
801+
&lt;a href="/v3/repos/contents/#delete-a-file"&gt;delete&lt;/a&gt; individual files.&lt;/p&gt;
802+
803+
&lt;p&gt;Happy editing!&lt;/p&gt;
804+
706805
</content>
707806
</entry>
708807
<entry>
@@ -730,25 +829,6 @@ but we can’t wait to see what others can do with this information.&lt;/p&gt;
730829
&lt;/ul&gt;
731830

732831
&lt;p&gt;Enjoy!&lt;/p&gt;
733-
</content>
734-
</entry>
735-
<entry>
736-
<id>tag:developer.github.com,2013-05-06:/changes/2013-05-06-create-update-delete-individual-files/</id>
737-
<title type="html">Create, update, and delete individual files</title>
738-
<published>2013-05-06T04:00:00Z</published>
739-
<updated>2013-05-06T04:00:00Z</updated>
740-
<author>
741-
<name>ymendel</name>
742-
<uri>https://github.com/technoweenie</uri>
743-
</author>
744-
<link rel="alternate" href="http://developer.github.com/changes/2013-05-06-create-update-delete-individual-files/" />
745-
<content type="html">&lt;p&gt;We’re following in the footsteps of GitHub.com’s ability to &lt;a href="https://github.com/blog/143-inline-file-editing"&gt;edit&lt;/a&gt; and
746-
&lt;a href="https://github.com/blog/1327-creating-files-on-github"&gt;create&lt;/a&gt; files in your web browser. Starting today, the
747-
&lt;a href="/v3/repos/contents/"&gt;Repository Contents API&lt;/a&gt; will let you easily &lt;a href="/v3/repos/contents/#create-a-file"&gt;create&lt;/a&gt;, &lt;a href="/v3/repos/contents/#update-a-file"&gt;update&lt;/a&gt;, and even
748-
&lt;a href="/v3/repos/contents/#delete-a-file"&gt;delete&lt;/a&gt; individual files.&lt;/p&gt;
749-
750-
&lt;p&gt;Happy editing!&lt;/p&gt;
751-
752832
</content>
753833
</entry>
754834
<entry>
@@ -1115,36 +1195,6 @@ regardless of what you send in the &lt;code&gt;type&lt;/code&gt; parameter.&lt;/
11151195
&lt;/ul&gt;
11161196

11171197
&lt;p&gt;&lt;strong&gt;EDIT:&lt;/strong&gt; &lt;code&gt;Link&lt;/code&gt; headers are our preferred navigation technique.&lt;/p&gt;
1118-
</content>
1119-
</entry>
1120-
<entry>
1121-
<id>tag:developer.github.com,2012-12-08:/changes/2012-12-08-finding-source-and-fork-repos-for-organizations/</id>
1122-
<title type="html">Finding sources and fork repositories for organizations</title>
1123-
<published>2012-12-08T05:00:00Z</published>
1124-
<updated>2012-12-08T05:00:00Z</updated>
1125-
<author>
1126-
<name>rick</name>
1127-
<uri>https://github.com/technoweenie</uri>
1128-
</author>
1129-
<link rel="alternate" href="http://developer.github.com/changes/2012-12-08-finding-source-and-fork-repos-for-organizations/" />
1130-
<content type="html">&lt;p&gt;We’ve made a couple of changes today to the Organization repositories
1131-
listing to bring it a bit closer to the functionality of the GitHub.com
1132-
Organization repositories tab. We now let you retrieve repositories
1133-
which are forks of another repository, as well as those repositories which
1134-
are sources (not forks).&lt;/p&gt;
1135-
1136-
&lt;pre&gt;&lt;code&gt;# Grab all fork Repositories for an Organization
1137-
curl "https://api.github.com/orgs/:org/repos?type=forks"
1138-
1139-
# Grab all source Repositories for an Organization
1140-
curl "https://api.github.com/orgs/:org/repos?type=sources"
1141-
&lt;/code&gt;&lt;/pre&gt;
1142-
1143-
&lt;p&gt;Check out the docs for sorting and filtering options:&lt;/p&gt;
1144-
1145-
&lt;ul&gt;
1146-
&lt;li&gt;&lt;a href="/v3/repos/#list-organization-repositories"&gt;Organization Repositories&lt;/a&gt;&lt;/li&gt;
1147-
&lt;/ul&gt;
11481198
</content>
11491199
</entry>
11501200
</feed>

‎changes/2012-10-14-rate-limit-changes/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,8 @@ <h2 class="title">
8686
<h2>Recent Posts</h2>
8787
<ul class="headlines sidebar-module">
8888

89+
<li><a href="/changes/2014-01-09-preview-the-new-deployments-api/">Preview the New Deployments API<br /><span class="date">January 9, 2014</span></a></li>
90+
8991
<li><a href="/changes/2014-01-07-upcoming-change-to-default-media-type/">Upcoming Change to Default Media Type<br /><span class="date">January 7, 2014</span></a></li>
9092

9193
<li><a href="/changes/2013-12-13-paginating-org-members/">Paginated results for organization members<br /><span class="date">December 13, 2013</span></a></li>
@@ -100,8 +102,6 @@ <h2>Recent Posts</h2>
100102

101103
<li><a href="/changes/2013-10-04-oauth-changes-coming/">OAuth changes coming<br /><span class="date">October 4, 2013</span></a></li>
102104

103-
<li><a href="/changes/2013-09-28-an-update-on-the-new-search-api/">An Update on the New Search API<br /><span class="date">September 28, 2013</span></a></li>
104-
105105
</ul>
106106

107107

‎changes/2012-10-17-org-members-redirection/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ <h2 class="title">
8888
<h2>Recent Posts</h2>
8989
<ul class="headlines sidebar-module">
9090

91+
<li><a href="/changes/2014-01-09-preview-the-new-deployments-api/">Preview the New Deployments API<br /><span class="date">January 9, 2014</span></a></li>
92+
9193
<li><a href="/changes/2014-01-07-upcoming-change-to-default-media-type/">Upcoming Change to Default Media Type<br /><span class="date">January 7, 2014</span></a></li>
9294

9395
<li><a href="/changes/2013-12-13-paginating-org-members/">Paginated results for organization members<br /><span class="date">December 13, 2013</span></a></li>
@@ -102,8 +104,6 @@ <h2>Recent Posts</h2>
102104

103105
<li><a href="/changes/2013-10-04-oauth-changes-coming/">OAuth changes coming<br /><span class="date">October 4, 2013</span></a></li>
104106

105-
<li><a href="/changes/2013-09-28-an-update-on-the-new-search-api/">An Update on the New Search API<br /><span class="date">September 28, 2013</span></a></li>
106-
107107
</ul>
108108

109109

‎changes/2012-10-24-set-default-branch/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ <h2 class="title">
8383
<h2>Recent Posts</h2>
8484
<ul class="headlines sidebar-module">
8585

86+
<li><a href="/changes/2014-01-09-preview-the-new-deployments-api/">Preview the New Deployments API<br /><span class="date">January 9, 2014</span></a></li>
87+
8688
<li><a href="/changes/2014-01-07-upcoming-change-to-default-media-type/">Upcoming Change to Default Media Type<br /><span class="date">January 7, 2014</span></a></li>
8789

8890
<li><a href="/changes/2013-12-13-paginating-org-members/">Paginated results for organization members<br /><span class="date">December 13, 2013</span></a></li>
@@ -97,8 +99,6 @@ <h2>Recent Posts</h2>
9799

98100
<li><a href="/changes/2013-10-04-oauth-changes-coming/">OAuth changes coming<br /><span class="date">October 4, 2013</span></a></li>
99101

100-
<li><a href="/changes/2013-09-28-an-update-on-the-new-search-api/">An Update on the New Search API<br /><span class="date">September 28, 2013</span></a></li>
101-
102102
</ul>
103103

104104

‎changes/2012-10-26-notifications-api/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,8 @@ <h2 id="polling">Polling</h2>
129129
<h2>Recent Posts</h2>
130130
<ul class="headlines sidebar-module">
131131

132+
<li><a href="/changes/2014-01-09-preview-the-new-deployments-api/">Preview the New Deployments API<br /><span class="date">January 9, 2014</span></a></li>
133+
132134
<li><a href="/changes/2014-01-07-upcoming-change-to-default-media-type/">Upcoming Change to Default Media Type<br /><span class="date">January 7, 2014</span></a></li>
133135

134136
<li><a href="/changes/2013-12-13-paginating-org-members/">Paginated results for organization members<br /><span class="date">December 13, 2013</span></a></li>
@@ -143,8 +145,6 @@ <h2>Recent Posts</h2>
143145

144146
<li><a href="/changes/2013-10-04-oauth-changes-coming/">OAuth changes coming<br /><span class="date">October 4, 2013</span></a></li>
145147

146-
<li><a href="/changes/2013-09-28-an-update-on-the-new-search-api/">An Update on the New Search API<br /><span class="date">September 28, 2013</span></a></li>
147-
148148
</ul>
149149

150150

‎changes/2012-10-31-gist-comment-uris/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ <h2 class="title">
7474
<h2>Recent Posts</h2>
7575
<ul class="headlines sidebar-module">
7676

77+
<li><a href="/changes/2014-01-09-preview-the-new-deployments-api/">Preview the New Deployments API<br /><span class="date">January 9, 2014</span></a></li>
78+
7779
<li><a href="/changes/2014-01-07-upcoming-change-to-default-media-type/">Upcoming Change to Default Media Type<br /><span class="date">January 7, 2014</span></a></li>
7880

7981
<li><a href="/changes/2013-12-13-paginating-org-members/">Paginated results for organization members<br /><span class="date">December 13, 2013</span></a></li>
@@ -88,8 +90,6 @@ <h2>Recent Posts</h2>
8890

8991
<li><a href="/changes/2013-10-04-oauth-changes-coming/">OAuth changes coming<br /><span class="date">October 4, 2013</span></a></li>
9092

91-
<li><a href="/changes/2013-09-28-an-update-on-the-new-search-api/">An Update on the New Search API<br /><span class="date">September 28, 2013</span></a></li>
92-
9393
</ul>
9494

9595

‎changes/2012-11-27-forking-to-organizations/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ <h2 class="title">
9393
<h2>Recent Posts</h2>
9494
<ul class="headlines sidebar-module">
9595

96+
<li><a href="/changes/2014-01-09-preview-the-new-deployments-api/">Preview the New Deployments API<br /><span class="date">January 9, 2014</span></a></li>
97+
9698
<li><a href="/changes/2014-01-07-upcoming-change-to-default-media-type/">Upcoming Change to Default Media Type<br /><span class="date">January 7, 2014</span></a></li>
9799

98100
<li><a href="/changes/2013-12-13-paginating-org-members/">Paginated results for organization members<br /><span class="date">December 13, 2013</span></a></li>
@@ -107,8 +109,6 @@ <h2>Recent Posts</h2>
107109

108110
<li><a href="/changes/2013-10-04-oauth-changes-coming/">OAuth changes coming<br /><span class="date">October 4, 2013</span></a></li>
109111

110-
<li><a href="/changes/2013-09-28-an-update-on-the-new-search-api/">An Update on the New Search API<br /><span class="date">September 28, 2013</span></a></li>
111-
112112
</ul>
113113

114114

‎changes/2012-11-29-gitignore-templates/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ <h2 class="title">
118118
<h2>Recent Posts</h2>
119119
<ul class="headlines sidebar-module">
120120

121+
<li><a href="/changes/2014-01-09-preview-the-new-deployments-api/">Preview the New Deployments API<br /><span class="date">January 9, 2014</span></a></li>
122+
121123
<li><a href="/changes/2014-01-07-upcoming-change-to-default-media-type/">Upcoming Change to Default Media Type<br /><span class="date">January 7, 2014</span></a></li>
122124

123125
<li><a href="/changes/2013-12-13-paginating-org-members/">Paginated results for organization members<br /><span class="date">December 13, 2013</span></a></li>
@@ -132,8 +134,6 @@ <h2>Recent Posts</h2>
132134

133135
<li><a href="/changes/2013-10-04-oauth-changes-coming/">OAuth changes coming<br /><span class="date">October 4, 2013</span></a></li>
134136

135-
<li><a href="/changes/2013-09-28-an-update-on-the-new-search-api/">An Update on the New Search API<br /><span class="date">September 28, 2013</span></a></li>
136-
137137
</ul>
138138

139139

‎changes/2012-12-04-List-comments-for-repo/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ <h2 class="title">
8989
<h2>Recent Posts</h2>
9090
<ul class="headlines sidebar-module">
9191

92+
<li><a href="/changes/2014-01-09-preview-the-new-deployments-api/">Preview the New Deployments API<br /><span class="date">January 9, 2014</span></a></li>
93+
9294
<li><a href="/changes/2014-01-07-upcoming-change-to-default-media-type/">Upcoming Change to Default Media Type<br /><span class="date">January 7, 2014</span></a></li>
9395

9496
<li><a href="/changes/2013-12-13-paginating-org-members/">Paginated results for organization members<br /><span class="date">December 13, 2013</span></a></li>
@@ -103,8 +105,6 @@ <h2>Recent Posts</h2>
103105

104106
<li><a href="/changes/2013-10-04-oauth-changes-coming/">OAuth changes coming<br /><span class="date">October 4, 2013</span></a></li>
105107

106-
<li><a href="/changes/2013-09-28-an-update-on-the-new-search-api/">An Update on the New Search API<br /><span class="date">September 28, 2013</span></a></li>
107-
108108
</ul>
109109

110110

‎changes/2012-12-06-create-authorization-for-app/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ <h2 class="title">
9797
<h2>Recent Posts</h2>
9898
<ul class="headlines sidebar-module">
9999

100+
<li><a href="/changes/2014-01-09-preview-the-new-deployments-api/">Preview the New Deployments API<br /><span class="date">January 9, 2014</span></a></li>
101+
100102
<li><a href="/changes/2014-01-07-upcoming-change-to-default-media-type/">Upcoming Change to Default Media Type<br /><span class="date">January 7, 2014</span></a></li>
101103

102104
<li><a href="/changes/2013-12-13-paginating-org-members/">Paginated results for organization members<br /><span class="date">December 13, 2013</span></a></li>
@@ -111,8 +113,6 @@ <h2>Recent Posts</h2>
111113

112114
<li><a href="/changes/2013-10-04-oauth-changes-coming/">OAuth changes coming<br /><span class="date">October 4, 2013</span></a></li>
113115

114-
<li><a href="/changes/2013-09-28-an-update-on-the-new-search-api/">An Update on the New Search API<br /><span class="date">September 28, 2013</span></a></li>
115-
116116
</ul>
117117

118118

0 commit comments

Comments
 (0)