Skip to content

Latest commit

 

History

History
78 lines (55 loc) · 1.66 KB

README.md

File metadata and controls

78 lines (55 loc) · 1.66 KB
Raw

fbi commit

git commit and npm publish flow, formatting commit messages with commitizen.

This is a fbi task. If you haven't installed fbi v4 yet, use the following command to install.

$ npm i -g fbi or yarn global add fbi

Requirements

  • fbi v4+
  • node v10+

Features

  • flow of git add, git commit, git push, git tag, npm version major/minor/patch, npm publish, and changelog generation
  • formatting commit messages with commitizen
  • version standard: Semantic Versioning
  • git commit and changelog style: Angular commit style
    • commit message format: type(scope): subject
    • commit types: cz-fbi
    • changelog: only new features, bug fixes, breaking changes will show in CHANGELOG.md

Format

<type>(<scope>): <subject>

<body>

<footer>

Usage

Install

$ fbi add factory-commands

Run

$ cd path/to/git/repository
$ fbi commit

Demo

  • ? type of change (required): feat ✨ Introducing new features

  • ? affected scope (optional): page

  • ? short description (required): add a new page

  • ? longer description (optional): \n - first \n - second \n - third

  • ? issue closed (optional): #666 #999

  • ? breaking change (optional): some breaking changes

    result:

    feat(page): add a new page

- first
- second
- third

fixed #666, fixed #999

BREAKING CHANGE:
some breaking changes