GitHub Conventional Release Bot

A GitHub App built with Probot that creates GitHub Release following Conventional Commits.

Usage

1. Install and configure the GitHub App: github.com/apps/conventional-release-bot
2. Add commit that message structure should following Conventional Commits

<type>[optional scope]: <description>

[optional body]

[optional footer]

3. Push commits (or merged PR) to master branch, and then the GitHub Release will be created

1. Git tags (based on SemVer)
2. Release date
3. Release types: Bug Fixes, New Features and BREAKING CHANGES (follow Conventional Commits's type)
4. Commit's scope (follow Conventional Commits's scope)
5. Commit's description
6. Commit's SHA
7. Commit's author
8. Diff with last release

Developer Guide

Follow the Configure a GitHub App section of Probot document to create your GitHub App

Requirements

• node >= 8.9.3
• yarn >= 1.3.2

Permissions

• Pull requests Access: Read & write
• Repository contents Access: Read & write

Subscribe to events

• Pull request

Installation

Clone repository:

$ git clone https://github.com/hahow/probot-conventional-release.git

Install packages:

$ yarn install

Run Probot server:

$ yarn start

Deployment

You can deploy the app to Glitch, Heroku or Now.