# README

gh-release

Utility for creating, deleting, and uploading files to Github Releases.

Getting gh-release

Download and uncompress the appropriate binary from releases.

Using gh-release

You need to have a Github personal access token defined in your environment as GITHUB_ACCESS_TOKEN.

$ gh-release 
Usage: gh-release create|destroy <reponame> <version> [branch] [name]

Creating a release with assets

Put any assets you want to upload with your release into a release directory. Then call gh-release. Here is an example:

$ gh-release create progrium/gh-release 1.0.0

This will create a tagged release v1.0.0 then upload any files found in the ./release directory. Optional arguments you can pass include the branch to tag the release from and a name for the release.

See this project's Makefile for a real example of using it in a Makefile.

Destroying a release

You can destroy a release by the version number you used to create the release:

$ gh-release destroy progrium/gh-release 1.0.0

This destroys the release and its assets, as well as the v1.0.0 tag created for the release.

Sponsor

This project was made possible thanks to DigitalOcean.