Tips for Increasing Version Number with Gulp Task

Question

Tips for Increasing Version Number with Gulp Task

Looking to update the version number in a JavaScript file (myConstantsFile.js) with a new string. Currently, the version number is "01.11.15" and appears like this in myConstantsFile.js along with other constants:

.constant('productVersion', '1.11.15');

Currently, the task involves:

gulp.task('increment-version', function(){
    gulp.src(['./somedir/myConstantsFile.js'])
        .pipe(replace(/'productVersion', '(.*)'/g, '99.99.99'))
        .pipe(gulp.dest('./somedir/'));
});

Instead of using direct incrementation code, I am utilizing a constant value.

    var numberString = '0.0.1';
    var versionParts = numberString.split('.');
    var vArray = {
      vMajor : versionParts[0],
      vMinor : versionParts[1],
      vPatch : versionParts[2]
    } 

    vArray.vPatch = parseFloat(vArray.vPatch) + 1;
    var periodString = ".";

    var newVersionNumberString = vArray.vMajor + periodString + 
                                vArray.vMinor+ periodString + 
                                vArray.vPatch;

Specifically, I require:

A method to select the current version number in the file via regex.
The location in the code block where the logic can be inserted to increment the number and generate the updated string.

javascript angularjs gulp build-process

Answer 1

Answer №1

Download and set up gulp-bump

npm install gulp-bump --save-dev

Get yargs

npm install yargs --save-dev

Utilize gulp-bump

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

Utilize yargs

var args = require('yargs').argv;

Create your bump task

gulp.task('bump', function () {
    /// <summary>
    /// It bumps revisions
    /// Usage:
    /// 1. gulp bump : bumps the package.json and bower.json to the next minor revision.
    ///   i.e. from 0.1.1 to 0.1.2
    /// 2. gulp bump --version 1.1.1 : bumps/sets the package.json and bower.json to the 
    ///    specified revision.
    /// 3. gulp bump --type major       : bumps 1.0.0 
    ///    gulp bump --type minor       : bumps 0.1.0
    ///    gulp bump --type patch       : bumps 0.0.2
    ///    gulp bump --type prerelease  : bumps 0.0.1-2
    /// </summary>

    var type = args.type;
    var version = args.version;
    var options = {};
    if (version) {
        options.version = version;
        msg += ' to ' + version;
    } else {
        options.type = type;
        msg += ' for a ' + type;
    }


    return gulp
        .src(['Path to your package.json', 'path to your bower.json'])
        .pipe(bump(options))
        .pipe(gulp.dest('path to your root directory'));
});

Note: The following code edit the version number stored in a different location, like in angular constants:

gulp.task('increment-version', function(){
    //docString is the file from which you will get your constant string
    var docString = fs.readFileSync('./someFolder/constants.js', 'utf8');

    //The code below gets your semantic v# from docString
    var versionNumPattern=/'someTextPreceedingVNumber', '(.*)'/; //This is just a regEx with a capture group for version number
    var vNumRexEx = new RegExp(versionNumPattern);
    var oldVersionNumber = (vNumRexEx.exec(docString))[1]; //This gets the captured group

    //...Split the version number string into elements so you can bump the one you want
    var versionParts = oldVersionNumber.split('.');
    var vArray = {
        vMajor : versionParts[0],
        vMinor : versionParts[1],
        vPatch : versionParts[2]
    };

    vArray.vPatch = parseFloat(vArray.vPatch) + 1;
    var periodString = ".";

    var newVersionNumber = vArray.vMajor + periodString +
                           vArray.vMinor+ periodString +
                           vArray.vPatch;

    gulp.src(['./someFolder/constants.js'])
        .pipe(replace(/'someTextPreceedingVNumber', '(.*)'/g, newVersionNumber))
        .pipe(gulp.dest('./someFolder/'));
});

I ommitted some details that format my constant in a readable way, but this is the core functionality and it works.

Answer 2

Download and set up gulp-bump

npm install gulp-bump --save-dev

Get yargs

npm install yargs --save-dev

Utilize gulp-bump

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

Utilize yargs

var args = require('yargs').argv;

Create your bump task

gulp.task('bump', function () {
    /// <summary>
    /// It bumps revisions
    /// Usage:
    /// 1. gulp bump : bumps the package.json and bower.json to the next minor revision.
    ///   i.e. from 0.1.1 to 0.1.2
    /// 2. gulp bump --version 1.1.1 : bumps/sets the package.json and bower.json to the 
    ///    specified revision.
    /// 3. gulp bump --type major       : bumps 1.0.0 
    ///    gulp bump --type minor       : bumps 0.1.0
    ///    gulp bump --type patch       : bumps 0.0.2
    ///    gulp bump --type prerelease  : bumps 0.0.1-2
    /// </summary>

    var type = args.type;
    var version = args.version;
    var options = {};
    if (version) {
        options.version = version;
        msg += ' to ' + version;
    } else {
        options.type = type;
        msg += ' for a ' + type;
    }


    return gulp
        .src(['Path to your package.json', 'path to your bower.json'])
        .pipe(bump(options))
        .pipe(gulp.dest('path to your root directory'));
});

Note: The following code edit the version number stored in a different location, like in angular constants:

gulp.task('increment-version', function(){
    //docString is the file from which you will get your constant string
    var docString = fs.readFileSync('./someFolder/constants.js', 'utf8');

    //The code below gets your semantic v# from docString
    var versionNumPattern=/'someTextPreceedingVNumber', '(.*)'/; //This is just a regEx with a capture group for version number
    var vNumRexEx = new RegExp(versionNumPattern);
    var oldVersionNumber = (vNumRexEx.exec(docString))[1]; //This gets the captured group

    //...Split the version number string into elements so you can bump the one you want
    var versionParts = oldVersionNumber.split('.');
    var vArray = {
        vMajor : versionParts[0],
        vMinor : versionParts[1],
        vPatch : versionParts[2]
    };

    vArray.vPatch = parseFloat(vArray.vPatch) + 1;
    var periodString = ".";

    var newVersionNumber = vArray.vMajor + periodString +
                           vArray.vMinor+ periodString +
                           vArray.vPatch;

    gulp.src(['./someFolder/constants.js'])
        .pipe(replace(/'someTextPreceedingVNumber', '(.*)'/g, newVersionNumber))
        .pipe(gulp.dest('./someFolder/'));
});

I ommitted some details that format my constant in a readable way, but this is the core functionality and it works.

Answer 3

Answer №2

For the past 5 hours, I've been diving into the world of gulp to tackle a task that required my attention. As a complete newbie to gulp, I managed to come up with the following code that does not involve regex expressions. Huge thanks to @VSO and @Wilmer Saint for providing me with a quick starting point. It may seem like a small change, but it made a huge difference for me.

gulp.task('version', function(){
  var fs = require('fs');
    //docString is the file from which you will get your constant string
    var docString = fs.readFileSync('app/scripts/version/version.js', 'utf8'); //type of docString i an object here.

    var versionParts = docString.split('.');

    var vArray = {
        vMajor : versionParts[0],
        vMinor : versionParts[1],
        vPatch : versionParts[2]
    };

    vArray.vPatch = parseFloat(vArray.vPatch) + 1;
    var periodString = ".";
    var newVersionNumber = vArray.vMajor + periodString +
                           vArray.vMinor+ periodString +
                           vArray.vPatch;



    require('fs').writeFileSync('app/scripts/version/version.js', newVersionNumber + "'");
        return gulp.src(['app/scripts/version/version.js'])
            .pipe(gulp.dest('app/scripts/version/new_version'));//creates version.js file in the directory
    });

Alternatively, the return code could be modified as follows to update the number in the version.js file:

return gulp.src(['app/scripts/version/version.js'],
                {base: './app/scripts/version/version.js'})
        .pipe((gulp.dest('./app/scripts/version/version.js')))

The content of my version.js file is simply:

versionBuild = '1.0.8'

In my main function (which loads when the app starts), I used the following code snippet:

var versionBuild=parseInt(1000*Math.random());
var random = function(digs){
    var rndn;
    if(window.location.hostname === "localhost" || window.location.hostname === "127.0.0.1") {
        rndn = Math.random();
        if(digs != undefined && !isNaN(digs)){
              rndn =  parseInt(Math.pow(10, digs)*rndn)
              }
              return rndn;
    }
    else {
        return versionBuild;
    }
}

Answer 4

For the past 5 hours, I've been diving into the world of gulp to tackle a task that required my attention. As a complete newbie to gulp, I managed to come up with the following code that does not involve regex expressions. Huge thanks to @VSO and @Wilmer Saint for providing me with a quick starting point. It may seem like a small change, but it made a huge difference for me.

gulp.task('version', function(){
  var fs = require('fs');
    //docString is the file from which you will get your constant string
    var docString = fs.readFileSync('app/scripts/version/version.js', 'utf8'); //type of docString i an object here.

    var versionParts = docString.split('.');

    var vArray = {
        vMajor : versionParts[0],
        vMinor : versionParts[1],
        vPatch : versionParts[2]
    };

    vArray.vPatch = parseFloat(vArray.vPatch) + 1;
    var periodString = ".";
    var newVersionNumber = vArray.vMajor + periodString +
                           vArray.vMinor+ periodString +
                           vArray.vPatch;



    require('fs').writeFileSync('app/scripts/version/version.js', newVersionNumber + "'");
        return gulp.src(['app/scripts/version/version.js'])
            .pipe(gulp.dest('app/scripts/version/new_version'));//creates version.js file in the directory
    });

Alternatively, the return code could be modified as follows to update the number in the version.js file:

return gulp.src(['app/scripts/version/version.js'],
                {base: './app/scripts/version/version.js'})
        .pipe((gulp.dest('./app/scripts/version/version.js')))

The content of my version.js file is simply:

versionBuild = '1.0.8'

In my main function (which loads when the app starts), I used the following code snippet:

var versionBuild=parseInt(1000*Math.random());
var random = function(digs){
    var rndn;
    if(window.location.hostname === "localhost" || window.location.hostname === "127.0.0.1") {
        rndn = Math.random();
        if(digs != undefined && !isNaN(digs)){
              rndn =  parseInt(Math.pow(10, digs)*rndn)
              }
              return rndn;
    }
    else {
        return versionBuild;
    }
}

Answer 5

Answer №3

Try out gulp-bump for an easy and delightful experience :)

npm install --save gulp-bump

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

gulp.task('bump', async () => {
    gulp.src('./package.json')
    .pipe(bump({key: "version"}))
    .pipe(gulp.dest('./'));
  });

Remember to include async before a function, it's necessary.

Answer 6

Try out gulp-bump for an easy and delightful experience :)

npm install --save gulp-bump

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

gulp.task('bump', async () => {
    gulp.src('./package.json')
    .pipe(bump({key: "version"}))
    .pipe(gulp.dest('./'));
  });

Remember to include async before a function, it's necessary.

Answer 7

Answer №4

task('updateVersion', function() {
    var version = JSON.parse(fs.readFileSync(__dirname + '/package.json')).version.split('.');
    var middleNum = parseInt(version[1]);
    var lastNum  = parseInt(version[2]);
    var config = { property: 'version' };

    if(lastNum == 9 && middleNum != 9) {
        lastNum = 0;
        config.updateType = 'minor';
    } else if (middleNum == 9 && lastNum == 9) {
        middleNum = 0;
        config.updateType = 'major';
    }

    gulp.src(__dirname + '/package.json')
    .pipe(updateVersion(config))
    .pipe(gulp.dest('./'));
});

Answer 8

task('updateVersion', function() {
    var version = JSON.parse(fs.readFileSync(__dirname + '/package.json')).version.split('.');
    var middleNum = parseInt(version[1]);
    var lastNum  = parseInt(version[2]);
    var config = { property: 'version' };

    if(lastNum == 9 && middleNum != 9) {
        lastNum = 0;
        config.updateType = 'minor';
    } else if (middleNum == 9 && lastNum == 9) {
        middleNum = 0;
        config.updateType = 'major';
    }

    gulp.src(__dirname + '/package.json')
    .pipe(updateVersion(config))
    .pipe(gulp.dest('./'));
});

Tips for Increasing Version Number with Gulp Task

Answer №1

Answer №2

Answer №3

Answer №4

Similar questions

Dynamic Filtering with Reactjs Autocomplete Component (Material UI) using API calls on each input modification

Issue encountered while trying to pass updated values from an Angular UI modal back to the parent screen

Iterating through elements with JavaScript and dynamically replacing them in the HTML code

Execute supplementary build scripts during the angular build process

I encountered an issue with the onclick event in JavaScript

Perform a series of observables from a dynamically generated array

On mobile devices, the height of the absolutely positioned element is larger than its

What kind of information is revealed by passing `this` to a function within ng-click?

Validation of textfields using React.js

What is the process for accessing a website using Java programming language?

Karma test encountered a provider that could not be identified

loop through the array of objects using ng-repeat in Angular

The Position of the WebGL Globe Within the Environment

Inspect the JavaScript file for errors and find a solution to overcome them

What is the best way to navigate to the contact section after clicking on the "Contact Us" button within a modal?

Converting Repository Objects to Json in Symfony3

Uncovering design elements from Material UI components

Creating a circular shape around a specific location on a map is a common task in Openlayers. Here's a

Error: The configuration property is not defined, causing a TypeError at Class.run ~/node_modules/angular-cli/tasks/serve.js on line 22

The choice between invoking a function within a route handler or employing a middleware for the task