0
0
mirror of https://github.com/thegeeklab/wp-gitea-release.git synced 2024-11-09 17:30:39 +00:00
wp-gitea-release/DOCS.md
2016-02-11 14:24:46 +01:00

977 B

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
  • 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:

publish:
  github_release:
    api_key: my_github_api_key
    files: dist/*
    checksum: sha1

or

publish:
  github_release:
    api_key: my_github_api_key
    files:
      - dist/*
      - bin/binary.exe
    checksum:
      - md5
      - sha1
      - sha256
      - sha512
      - adler32
      - crc32