Skip to content

Command line interface to make a github release of your repository.

License

Notifications You must be signed in to change notification settings

moremoban/gease

Repository files navigation

gease - gITHUB RELease

https://codecov.io/github/moremoban/gease/coverage.png https://pepy.tech/badge/gease/month https://img.shields.io/github/stars/moremoban/gease.svg?style=social&maxAge=3600&label=Star https://img.shields.io/static/v1?label=continuous%20templating&message=%E6%A8%A1%E7%89%88%E6%9B%B4%E6%96%B0&color=blue&style=flat-square https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square

It's understood that you may use github cli, however gease simply makes a git release using github api v3.

https://github.com/moremoban/gease/raw/master/images/cli.png

Installation

You can install gease via pip:

$ pip install gease

or clone it and install it:

$ git clone https://github.com/moremoban/gease.git
$ cd gease
$ python setup.py install

Setup and Configuration

First, please create personal access token for yourself on github.

https://github.com/moremoban/gease/raw/master/images/generate_token.png

Next, please create a gease file(.gease) in your home directory and place the token inside it. Gease file is a simple json file. Here is an example:

{"user":"chfw","personal_access_token":"AAFDAFASDFADFADFADFADFADF"}

Organisation

In order to make a release for your organisation, "read:org" right is required:

https://user-images.githubusercontent.com/4280312/33229231-0220f60e-d1c3-11e7-8c95-3e1207415929.png

Command Line

gease simply makes a git release using github api v3. version 0.0.1

Usage: gs repo tag [release message]

where:

   release message is optional. It could be a quoted string or space separate
       string

Examples:

   gs gease v0.0.1 first great release
   gs gease v0.0.2 "second great release"

:: contributors list the contributors of a repo. version 0.0.4

Usage: contributors user/org repo

Where:
user/org is the your github username or orgnisation name repo is the repository name

Examples:

contributors pyexcel pyexcel-io

License

MIT