Skip to content

Commit 05bb760

Browse files
authored
Merge pull request travis-ci#2286 from travis-ci/releases-strict-payload
Enumerate valid GitHub Releases options
2 parents 2083f94 + 098648b commit 05bb760

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

user/deployment/releases.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -247,16 +247,15 @@ after_deploy:
247247

248248
## Advanced options
249249

250-
Options from `.travis.yml` are passed through to Octokit API's
250+
The following options from `.travis.yml` are passed through to Octokit API's
251251
[#create_release](https://octokit.github.io/octokit.rb/Octokit/Client/Releases.html#create_release-instance_method)
252-
and [#update_release](https://octokit.github.io/octokit.rb/Octokit/Client/Releases.html#update_release-instance_method) methods,
253-
so you can use any valid Octokit option,
254-
unless they are treated separately in this document.
255-
256-
These include:
252+
and [#update_release](https://octokit.github.io/octokit.rb/Octokit/Client/Releases.html#update_release-instance_method) methods.
257253

254+
* `tag_name`
255+
* `target_commitish`
258256
* `name`
259257
* `body`
258+
* `draft` (boolean)
260259
* `prerelease` (boolean)
261260

262261
Note that formatting in `body` is [not preserved](https://github.com/travis-ci/dpl/issues/155).

0 commit comments

Comments
 (0)