https://github.com/leobalter/ya-bump

Yet Another module to Bump, Commit and Publish
https://github.com/leobalter/ya-bump

Last synced: about 2 months ago
JSON representation

Yet Another module to Bump, Commit and Publish

• Host: GitHub
• URL: https://github.com/leobalter/ya-bump
• Owner: leobalter
• Created: 2014-07-09T20:06:07.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-07-21T18:58:41.000Z (over 10 years ago)
• Last Synced: 2024-10-14T12:53:53.729Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 191 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ya-bump

Yet Another module to Bump, Commit and Publish

## Install

### Globally

`npm install -g ya-bump`

## CLI Usage

`ya-bump [options]`

### CLI Options:

| option | description |

|-----------:|:-----------|

| `-h, --help`         | output usage information |

| `-V, --version`      | output the version number |

| `-P, --publish`      | Enable publishing to NPM |

| `-C, --commit`       | Enable commiting changes |

| `-c, --clipboard`    | No writing - Copy the new version on NPM |

| `-n, --new [value]`  | Set a custom new version |

| `-M, --major`        | Set a major bump. Eg. 1.0.2 -> 2.0.0 |

| `-m, --minor`        | Set a minor bump. Eg. 1.0.2 -> 1.1.0 |

### As a Module

`npm install --save ya-bump`

## Module Usage

```js

var bump = require( "ya-bump" );

// default values listed below

bump({

	// Commits the modified bumped file

	commit: false,

	// Publishes in NPM

	publish: false,

	// Copy to clipboard, this option discards any writing change

	clipboard: false,

	// Version, it can be a valid semver or "patch", "minor" or "major"

	bump: "patch"

});

```

## TODO:

Set commit long description with last changes from git log