gulp-bump

Bump npm versions with Gulp (gulpjs.com)

npm install gulp-bump
19 downloads in the last day
410 downloads in the last week
1 845 downloads in the last month

gulp-bump

Build Status NPM version

Bump any json file which supports semver versioning

Information

Packagegulp-bump
Description Bump any Semver version json file with gulp (gulpjs.com)
Node Version >= 0.9
Gulp Version 3.x

Usage

If you are just requiring a bump for npm, consider using npm version

Install

npm install gulp-bump --save

Example

var gulp = require('gulp');
var bump = require('gulp-bump');

// Basic usage:
// Will patch the version
gulp.task('bump', function(){
  gulp.src('./component.json')
  .pipe(bump())
  .pipe(gulp.dest('./'));
});


// Defined method of updating:
// Semantic
gulp.task('bump', function(){
  gulp.src('./*.json')
  .pipe(bump({type:'minor'}))
  .pipe(gulp.dest('./'));
});

// Defined method of updating:
// Semantic major
gulp.task('bump', function(){
  gulp.src('./bower.json')
  .pipe(bump({type:'major'}))
  .pipe(gulp.dest('./'));
});


// Defined method of updating:
// Set a specific version
gulp.task('bump', function(){
  gulp.src('./*.json')
  .pipe(bump({version: '1.2.3'}))
  .pipe(gulp.dest('./'));
});


// Update bower, component, npm at once:
gulp.task('bump', function(){
  gulp.src(['./bower.json', './component.json', './package.json'])
  .pipe(bump({type:'major'}))
  .pipe(gulp.dest('./'));
});


// Define the tab size for indenting
gulp.task('bump', function(){
  gulp.src('./package.json')
  .pipe(bump({type:'major', indent: 4 }))
  .pipe(gulp.dest('./'));
});

// Define the key for versioning off
gulp.task('bump', function(){
  gulp.src('./package.json')
  .pipe(bump({key: "appversion"}))
  .pipe(gulp.dest('./'));
});




// Run the gulp tasks
gulp.task('default', function(){
  gulp.run('bump');
});

You can view more examples in the example folder.

Options

options.type

What type of version to bump to.

Type: `String`
Default: `patch`

options.key

Set the versioning key

Type: `String`
Default: `version`

Example:


.pipe(bump({key: 'appversion'}))
.pipe(bump({key: 'build-version'}))
.pipe(bump({key: 'dev-version', type: 'major'}))

options.version

Set a specific version.

Type: `String`
Default: `none`

Example:


.pipe(bump({version: '1.2.3'}))
.pipe(bump({version: '1.0.0-alpha'}))

Versioning Used: Semantic

String, lowercase

  • MAJOR ("major") version when you make incompatible API changes
  • MINOR ("minor") version when you add functionality in a backwards-compatible manner
  • PATCH ("patch") version when you make backwards-compatible bug fixes.

Version example

major: 1.0.0
minor: 0.1.0
patch: 0.0.2

LICENSE

(MIT License)

Copyright (c) 2014 Steve Lacy me@slacy.me slacy.me

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you