mirror of
https://github.com/thegeeklab/wp-gitea-release.git
synced 2024-11-10 03:40:40 +00:00
39 lines
1.1 KiB
Markdown
39 lines
1.1 KiB
Markdown
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
|
|
* `files` - Files to upload to GitHub Release, globs are allowed
|
|
* `file_exists` - What to do if an file asset already exists, supported values: **overwrite** (default), **skip** and **fail**
|
|
* `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.
|
|
* `draft` - create a draft release if set to true
|
|
* `base_url` - GitHub base URL, only required for GHE
|
|
* `upload_url` - GitHub upload URL, only required for GHE
|
|
|
|
Sample configuration:
|
|
|
|
```yaml
|
|
publish:
|
|
github_release:
|
|
api_key: my_github_api_key
|
|
files: dist/*
|
|
checksum: sha1
|
|
```
|
|
|
|
or
|
|
|
|
```yaml
|
|
publish:
|
|
github_release:
|
|
api_key: my_github_api_key
|
|
files:
|
|
- dist/*
|
|
- bin/binary.exe
|
|
checksum:
|
|
- md5
|
|
- sha1
|
|
- sha256
|
|
- sha512
|
|
- adler32
|
|
- crc32
|
|
```
|