https://github.com/steven-mercatante/releasify-web

Easily create semantic version releases for GitHub repos
https://github.com/steven-mercatante/releasify-web

github github-api python

Last synced: 3 days ago
JSON representation

Easily create semantic version releases for GitHub repos

• Host: GitHub
• URL: https://github.com/steven-mercatante/releasify-web
• Owner: steven-mercatante
• Created: 2019-02-13T00:06:09.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-02-19T02:55:50.000Z (over 5 years ago)
• Last Synced: 2024-10-11T13:12:09.217Z (about 1 month ago)
• Topics: github, github-api, python
• Language: Python
• Homepage:
• Size: 19.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Releasify - API Interface

[![Build Status](https://travis-ci.org/steven-mercatante/releasify-web.svg?branch=master)](https://travis-ci.org/steven-mercatante/releasify-web)

## What is this?

A RESTful API interface to the [releasify](https://github.com/steven-mercatante/releasify) library.

Releasify lets you quickly and easily automate the creation of [semantic version](https://semver.org/) releases for GitHub repos.

## How do I use it?

`POST` a JSON payload to `/releases`

### Authentication

Releasify uses pass-through authentication via [Basic access authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). You just need to provide the username and password of an account that has access to create releases on the repo. You can use a [Personal Access Token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) instead of a password.

**Releasify does not store these credentials - it just passes them to the GitHub API.**

### API Parameters

| Name | Description | Type | Required? |

| --- | --- | --- | --- |

| `owner` | The owner of the repo you want to create a release for | `string` | **Yes** |

| `repo` | The name of the repo you want to create a release for | `string` | **Yes** |

| `type` | The type of release to create. Must be one of `major`, `minor` or `patch`. | `string` | **Yes**

| `dry_run` | Perform a dry run to see what the new version will be. Releasify won't actually create the release if this argument is true. | `boolean` | No

| `force` | Create the release even if there haven't been any merge commits since the last release | `boolean` | No

| `draft` | Indicates if the release is a draft | `boolean` | No

| `prerelease` | Indicates if this is a prerelease | `boolean` | No

**Note** The above `boolean` parameters treat the following values as `true`: `"true"`, `"yes"`, `"y"`, `"1"`.

Here's an example using the excellent [HTTPie](https://httpie.org/) library:

```bash

http POST https://releasify.example.com/releases -a username:password owner=steven-mercatante repo=some-repo type=minor dry_run=y

```