Drone plugins > Github Release
github.svg

Github Release

by drone-plugins


The github-release plugin is used to publish files and artifacts to GitHub Release.

Example

kind: pipeline
name: default

steps:
- name: publish
  image: plugins/github-release
  settings:
    api_key: xxxxxxxx
    files: dist/*

Properties

  • api_key

    stringrequired

    GitHub oauth token with public_repo or repo permission. If you create your token, ensure you select the correct scope. For private repositories you have to select repo while public repositories only requires public_repo.

    Default: none

  • files

    arrayrequired

    files to upload to GitHub Release, globs are allowed

    Default: none

  • file_exists

    stringoptional

    what to do if an file asset already exists, supported values - overwrite, skip and fail.

    Default: overwrite

  • checksum

    stringoptional

    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.

    Default: none

  • draft

    booleanoptional

    create a draft release

    Default: false

  • prerelease

    booleanoptional

    create a pre-release

    Default: false

  • note

    stringoptional

    file or string with notes for the release

    Default: none

  • title

    stringrequired

    file or string for the title shown in the gitea release

    Default: none

  • base_url

    stringoptional

    GitHub base URL, only required for GHE

    Default: none

  • upload_url

    stringoptional

    GitHub upload URL, only required for GHE

    Default: none

  • overwrite

    booleanoptional

    force overwrite existing release informations (only title and note)

    Default: false