A GitHub App built with Probot that creates GitHub Release following Conventional Commits
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
__tests__
docs
lib
.env.example
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
app.json
index.js
package.json
yarn.lock

README.md

GitHub Conventional Release Bot

Build Status

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]
  1. Push commits (or merged PR) to master branch, and then the GitHub Release will be created

1_luxfee4jnww2lr9_22sdca

  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

34095403-40e42ca2-e40c-11e7-9fe6-eb28864bfc46

Subscribe to events

34095741-8fbe3a6a-e40d-11e7-923d-e2e959c724ab

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.