gulp-mswebdeploy-package

Create Microsoft(TM) Web Deploy Packages With Gulp on Any Platform

Introduction

gulp-mswebdeploy-package allows you to bundle you site file into a Microsoft(TM) compatible web deploy file that can be used to publish to IIS. It is useful for creating build for JavaScript \ HTML project that are built and publish with Visual Studio Online, Visual Studio Team Services, TFS or and system that supports Web Deploy. Please note this package DOES NOT DO THE ACTUAL DEPLOYMENT it simply creates the package.

Getting Started

npm install gulp-mswebdeploy-package --save-dev

Using the "mswebdeploy" task

    var mswebdeploy = require('gulp-mswebdeploy');
    
    gulp.task('package', function(){
        gulp.src('app/')
        .pipe( mswebdeploy({ 'source' : 'app', "dest" : "deploy" }) )
        .pipe( gulp.dest('/deploy') );
    });

This sample creates a web deploy package using the files in 'app' in a folder called 'deploy' in a package named 'webdeploy.zip' The folder structure of the source folder will be maintained in the package. There is currently no way to add individual files.

Using the "mswebdeploy" task with parameters

gulp.task('webdeploypackage', ['build'], function() {

    gulp.src('app/')
        .pipe(mswebdeploy({
            'source': 'app',
            "dest": "webdeploy",
            'parameters': [
                {
                    'parameter': {
                        '@name': 'ApiUrl',
                        '@description': 'Base URL for API',
                        'parameterEntry': {
                            '@type': 'TextFile',
                            '@scope': 'app\\\\app.constants.js',
                            '@match': 'http://localhost:9000/api'
                        }
                    }
                }
            ]
        }))
        .pipe(gulp.dest('/deploy'));
});

This sample is similar to above, but also defines a web deploy parameter called 'ApiUrl' whose value will be injected into the app\app.constants.js file. See https://technet.microsoft.com/en-us/library/dd569084(WS.10).aspx for more details on Web Deploy parameters.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Mocha.

Release History

0.1.0 : Beta Release
0.1.2 : Updated docs
0.1.3 : Updated package.json
0.1.4 : Code clean up and refactoring 0.1.5 : Added support for parameters in the Web Deploy package

gulp-mswebdeploy-package