Skip to content

fbi-templates/fbi-task-commit

Repository files navigation

fbi-task-commit

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

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

$ npm i -g fbi or yarn global add fbi

Requirements

  • fbi v3.0+
  • node v7.6+

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 https://github.com/fbi-templates/fbi-task-commit.git

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

Configs

package.json

{
  "name": "",
  "version": "",
  ...
  "cz-fbi": {
    "types": [
      {
        "emoji": "",
        "description": "Introducing new features",
        "name": "feat"
      },
      ...
    ],
    "scopes": ["page", "api", ...]
  }
}

More

License

MIT

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published