https://github.com/amowu/probot-conventional-release
A GitHub App built with Probot that creates GitHub Release following Conventional Commits
https://github.com/amowu/probot-conventional-release
conventional-commits probot probot-app semantic-release
Last synced: about 2 months ago
JSON representation
A GitHub App built with Probot that creates GitHub Release following Conventional Commits
- Host: GitHub
- URL: https://github.com/amowu/probot-conventional-release
- Owner: amowu
- License: isc
- Created: 2017-12-24T11:47:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-29T06:55:25.000Z (over 7 years ago)
- Last Synced: 2025-02-28T09:21:03.802Z (2 months ago)
- Topics: conventional-commits, probot, probot-app, semantic-release
- Language: JavaScript
- Homepage: https://github.com/apps/conventional-release-bot
- Size: 75.2 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GitHub Conventional Release Bot
[](https://travis-ci.org/amowu/probot-conventional-release)
> A GitHub App built with [Probot](https://github.com/probot/probot) that creates [GitHub Release](https://help.github.com/articles/about-releases/) following [Conventional Commits](http://conventionalcommits.org/).
## Usage
1. Install and configure the GitHub App: [github.com/apps/conventional-release-bot](https://github.com/apps/conventional-release-bot)
2. Add commit that message structure should following [Conventional Commits](http://conventionalcommits.org/)
```
[optional scope]:
[optional body]
[optional footer]
```
3. Push commits (or merged PR) to master branch, and then the [GitHub Release](https://help.github.com/articles/about-releases/) will be created
1. Git tags (based on [SemVer](https://semver.org/))
2. Release date
3. Release types: **Bug Fixes**, **New Features** and **BREAKING CHANGES** (follow [Conventional Commits](https://conventionalcommits.org/)'s type)
4. Commit's scope (follow [Conventional Commits](https://conventionalcommits.org/)'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](https://probot.github.io/docs/development/#configure-a-github-app) section of Probot document to create your GitHub App
### Requirements
- node >= 8.9.3
- yarn >= 1.3.2
### Permissions
### Subscribe to events
### 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](https://probot.github.io/docs/deployment/#glitch), [Heroku](https://probot.github.io/docs/deployment/#heroku) or [Now](https://probot.github.io/docs/deployment/#now).