Skip to content

Commit 7ab5142

Browse files
author
Hubot
committed
Sync changes from upstream repository
1 parent f16b0ac commit 7ab5142

File tree

2 files changed

+38
-14
lines changed

2 files changed

+38
-14
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
kind: change
3+
title: The Deployments API is official
4+
created_at: 2014-11-25
5+
author_name: atmos
6+
---
7+
8+
We're happy to announce that the [Deployments API][docs] is officially part
9+
of GitHub API v3. We now consider it stable for production use.
10+
11+
Thanks to everyone who provided feedback during the preview period. We got
12+
some great feedback, and hope this feature helps you build the tools you
13+
need to make GitHub the best place to ship exactly the way you want.
14+
15+
### Preview media type no longer needed
16+
17+
If you used the Deployments API during the preview period, you needed to
18+
provide a custom media type in the `Accept` header:
19+
20+
application/vnd.github.cannonball-preview+json
21+
22+
Now that the preview period has ended, you no longer need to pass this custom
23+
media type.
24+
25+
Instead, we [recommend][media-types] that you specify `v3` as the version in the
26+
`Accept` header:
27+
28+
application/vnd.github.v3+json
29+
30+
### Feedback
31+
32+
We'll never be done listening to you! As always, please don't hesitate to
33+
[share your feedback][feedback].
34+
35+
[docs]: /v3/repos/deployments
36+
[media-types]: /v3/media
37+
[feedback]: https://github.com/contact?form[subject]=Deployments+API

content/v3/repos/deployments.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,6 @@ title: Deployments | GitHub API
77
* TOC
88
{:toc}
99

10-
<div class="alert">
11-
<p>
12-
The Deployments API is currently available for developers to preview.
13-
During the preview period, the API may change without advance notice.
14-
Please see the <a href="/changes/2014-01-09-preview-the-new-deployments-api/">blog post</a> for full details.
15-
</p>
16-
17-
<p>
18-
To access the API during the preview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:
19-
<pre>application/vnd.github.cannonball-preview+json</pre>
20-
</p>
21-
</div>
22-
2310
Deployments are a request for a specific ref(branch,sha,tag) to be deployed.
2411
GitHub then dispatches deployment events that external services can listen for
2512
and act on. This enables developers and organizations to build loosely-coupled
@@ -146,7 +133,7 @@ Users with `repo` or `repo_deployment` scopes can create a deployment for a give
146133
Name | Type | Description
147134
-----|------|--------------
148135
`ref`|`string`| **Required**. The ref to deploy. This can be a branch, tag, or sha.
149-
`task`|`string`| **Required**. The named task to execute. e.g. `deploy` or `deploy:migrations`. Default: `deploy`
136+
`task`|`string`| Optional parameter to specify a task to execute, e.g. `deploy` or `deploy:migrations`. Default: `deploy`
150137
`auto_merge`|`boolean`| Optional parameter to merge the default branch into the requested ref if it is behind the default branch. Default: `true`
151138
`required_contexts`|`Array`| Optional array of status contexts verified against commit status checks. If this parameter is omitted from the parameters then all unique contexts will be verified before a deployment is created. To bypass checking entirely pass an empty array. Defaults to all unique contexts.
152139
`payload`|`string` | Optional JSON payload with extra information about the deployment. Default: `""`

0 commit comments

Comments
 (0)