Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/njakob/breeze
Git Flow CLI wrapper for NPM based products
https://github.com/njakob/breeze
bump-version cli git git-flow helper hotfix npm release tool versioning wrapper
Last synced: about 1 month ago
JSON representation
Git Flow CLI wrapper for NPM based products
- Host: GitHub
- URL: https://github.com/njakob/breeze
- Owner: njakob
- License: mit
- Created: 2017-01-17T20:38:44.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-17T12:17:17.000Z (almost 8 years ago)
- Last Synced: 2024-12-16T18:29:33.957Z (about 1 month ago)
- Topics: bump-version, cli, git, git-flow, helper, hotfix, npm, release, tool, versioning, wrapper
- Language: JavaScript
- Homepage:
- Size: 91.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# breeze [![NPM version][npm-status-image]][npm] [![Build Status][build-status-image]][travis] [![ESLint Config][eslint-config-image]][eslint-config]
> Git Flow CLI wrapper for NPM based products
Tired of typing long command lines, naming your hotfix and release branches or constantly checking the state of your repository before finishing branches? Breeze is a tool made for you!
Breeze is a wonderful simple CLI wrapper that would help you to deal with common repetitive tasks that must be done in an NPM based product. It also use a configuration file that can be checked-out in your repository to make sure all contributors use the same Git Flow parameters.
## Features
* Shared configuration through `.breezerc` file
* New release or new hotfix automatically bump package version
* Finishing a branch automatically perform the right operation according to the branch prefix
## Installation
With NPM:
```
$ npm install @njakob/breeze
```
With Yarn:
```
$ yarn add @njakob/breeze
```
## Usage
### Initialization
In order to initialize Breeze for your team, use the following command:
```sh
$ breeze init
```
This would create an initial `.breezerc` configuration file that you can checkout in your repository. Besides Git Flow parameters, bump commits for releases and hotfixies can also be configured through this file.
`.breezerc`
```json
{
"branch": {
"master": "master",
"develop": "develop"
},
"prefix": {
"feature": "feature/",
"release": "release/",
"hotfix": "hotfix/",
"version-tag": ""
},
"commit": {
"release": "Bump to %s",
"hotfix": "Bump to %s"
}
}
```
### Creating branches
For each Git Flow operation, a corresponding command is available in the CLI. As shown in the following example, only creating a feature requires a name. Both features and hofixes would automatically use the bumped version as name.
```sh
$ breeze feature
$ breeze release {minor|major}
$ breeze hotfix
```
### Finializing branches
Finishing a branch would automatically apply the correct operation regarding the prefix of the branch.
```sh
$ breeze finish
```
## Licences
`njakob/breeze` is licensed under the [MIT License][licence].
[licence]: LICENSE
[eslint-config]: https://github.com/njakob/eslint-config
[npm]: https://nodei.co/npm/@njakob/breeze
[travis]: https://travis-ci.org/njakob/breeze
[npm-status-image]: https://img.shields.io/npm/v/@njakob/breeze.svg
[build-status-image]: https://travis-ci.org/njakob/breeze.svg?branch=master
[eslint-config-image]: https://img.shields.io/badge/eslint_config-njakob-463fd4.svg