natto1784/gitea-release-resource
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Alex Suraci
2015-10-27 09:30:26 -07:00
parent e19842d3be
commit 657cb152b4
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -19,9 +19,10 @@ Fetches and creates versioned GitHub resources.
* `github_api_url`: *Optional.* If you use a non-public GitHub deployment then * `github_api_url`: *Optional.* If you use a non-public GitHub deployment then
you can set your API URL here. you can set your API URL here.
* `drafts`: *Optional.* When set to `true` only returns draft releases with * `drafts`: *Optional. Default `false`.* When set to `true`, `put` produces
semver compliant tags. Defaults to `false` returning only final releases drafts and `check` only detects drafts. If `false`, only non-draft releases
with semver compliant tags. will be detected and published. Note that releases must have semver compliant
tags to be detected, even if they're drafts.
### Example ### Example
@@ -97,5 +98,3 @@ matching the patterns in `globs` to the release.
* `globs`: *Optional.* A list of globs for files that will be uploaded alongside * `globs`: *Optional.* A list of globs for files that will be uploaded alongside
the created release. the created release.
* `draft`: *Optional.* A boolean to set the release in draft mode or not.