gulp-bump

Bump npm versions with Gulp (gulpjs.com)

gulp-bump

Bump any JSON file which supports semver versioning

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

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

$ npm install gulp-bump --save
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('./'));
});
 
// Override the tab size for indenting 
// (or simply omit to keep the current formatting) 
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('./'));
});
 
 
 
 
// `fs` is used instead of require to prevent caching in watch (require caches) 
 
var fs = require('fs');
var getPackageJson = function () {
  return JSON.parse(fs.readFileSync('./package.json', 'utf8'));
};
 
// bump versions on package/bower/manifest 
gulp.task('bump', function () {
  // reget package 
  var pkg = getPackageJson();
  // increment version 
  var newVer = semver.inc(pkg.version, 'patch');
 
  // uses gulp-filter 
  var manifestFilter = tasks.filter(['manifest.json']);
  var regularJsons = tasks.filter(['!manifest.json']);
 
  return gulp.src(['./bower.json', './package.json', './src/manifest.json'])
    .pipe(tasks.bump({
      version: newVer
    }))
    .pipe(manifestFilter)
    .pipe(gulp.dest('./src'))
    .pipe(manifestFilter.restore())
    .pipe(regularJsons)
    .pipe(gulp.dest('./'));
});
 
// Run the gulp tasks 
gulp.task('default', function(){
  gulp.run('bump');
});

####You can view more examples in the example folder.

Semver version type to bump.

Type: `String`
Default: `patch`
Valid values: `major|minor|patch|prerelease`

Example:

.pipe(bump({type: 'Major'})
.pipe(bump()) //--> defaults to patch 

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'}))
 
.pipe(bump({key: {'sublevel.version'}}))
 
/*
{
  "sublevel": {
    "version": "<semver>"
  }
}
*/

Set a specific version to bump to.

Type: `String`
Default: `null`

Example:

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

Set the amount of spaces for indentation in the result JSON file.

Type: `Number`
Default: Same as original source file

Versioning Used: Semantic

  • 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.
  • PRERELEASE ("prerelease") a pre-release version
major: 1.0.0
minor: 0.1.0
patch: 0.0.2
prerelease: 0.0.1-2

(MIT License)

Copyright (c) 2015 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.