2015-11-23 01:07:57 +01:00
Use this plugin for publishing files and artifacts to GitHub releases. You
can override the default configuration with the following parameters:
* `api_key` - GitHub oauth token with public_repo or repo permission
2015-12-23 15:17:14 +01:00
* `files` - Files to upload to GitHub Release, globs are allowed
2016-02-11 15:07:22 +01:00
* `file_exists` - What to do if an file asset already exists, supported values: **overwrite** (default), **skip** and **fail**
2016-01-15 22:30:59 +01:00
* `checksum` - Checksum takes hash methods to include in your GitHub release for the files specified. Supported hash methods include md5, sha1, sha256, sha512, adler32, and crc32.
2016-02-11 14:23:52 +01:00
* `draft` - create a draft release if set to true
2015-12-23 15:17:14 +01:00
* `base_url` - GitHub base URL, only required for GHE
* `upload_url` - GitHub upload URL, only required for GHE
2015-11-23 01:07:57 +01:00
Sample configuration:
```yaml
publish:
github_release:
api_key: my_github_api_key
2016-01-15 23:02:12 +01:00
files: dist/*
2016-01-15 22:30:59 +01:00
checksum: sha1
```
or
```yaml
publish:
github_release:
api_key: my_github_api_key
files:
- dist/*
2016-01-15 23:02:12 +01:00
- bin/binary.exe
2016-01-15 22:30:59 +01:00
checksum:
2016-01-15 18:29:12 +01:00
- md5
- sha1
- sha256
- sha512
- adler32
- crc32
2015-11-23 01:07:57 +01:00
```