MIT licensed
Maintained by Taylor Fausak
This version can be pinned in stack with:github-release-1.0.3@sha256:ddb555bee55ce89f801ab16e71be2afccc239df351ceca1879651c7be2171fe5,1578

Module documentation for 1.0.3

GitHub Release

Version badge Build badge Windows build badge

GitHub Release is a command-line utility for uploading files to GitHub releases.

The recommended way to get GitHub Release is to download the latest release for your operating system. These releases are, of course, added with GitHub Release itself.

Once you’ve got it, run it like so:

github-release upload \
  --token '...' \
  --owner 'someone' \
  --repo 'something' \
  --tag '1.2.3' \
  --file 'path/to/example.tgz' \
  --name 'example-1.2.3.tgz'

You can generate a token on the personal access tokens page of your personal settings. The file option is the path to the local file you want to upload. The name option is what the file should be called on the GitHub release.

GitHub Release is written in Haskell. If you want to build it yourself or use it in your project, you’ll want to get Stack. Once you’ve done that, you can install and use it from the command line.

stack --resolver nightly install github-release
stack exec -- github release upload # as above ...

Or you can use it from Haskell.

import qualified GitHubRelease
    "..."                 -- token
    "someone"             -- owner
    "something"           -- repo
    "1.2.3"               -- tag
    "path/to/example.tgz" -- file
    "example-1.2.3.tgz"   -- name

Inspired by


Change log

GitHub Release uses Semantic Versioning. The change log is available through the releases on GitHub.