gulp-maven-deploy

gulp-maven-deploy

A Gulp wrapper for the maven-deploy module. Enables you to have projects which are built with Gulp, but deploys to Maven repositories.

All the samples below requires a basic understanding of Gulp and Maven. Please look at the documentation for those projects for details.

Installing

$ npm install gulp-maven-deploy --save-dev

Sample usage in a gulpfile.js

Below are two configuration samples:

Configuring a task for deploying to a Maven proxy

var maven = require('gulp-maven-deploy');

gulp.task('deploy', function(){
	gulp.src('.')
	.pipe(maven.deploy({
		'config': {
			'groupId': 'com.mygroup',
			'type': 'war',
			'repositories': [
				{
					'id': 'some-repo-id',
					'url': 'http://some-repo/url'
				}
			]
		}
	}))
});

A task running a local Maven install:

var maven = require('gulp-maven-deploy');

gulp.task('deploy-local', function(){
	gulp.src('.')
	.pipe(maven.install({
		'config': {
			'groupId': 'com.mygroup',
			'type': 'war'
		}
	}))
});

Note: A local install in Maven means it is only available on your machine. A deployment is different as it means you ship the artifact off to some remote repository.

Sample project

There is a complete sample project if you checkout the samples directory.

$ npm install
$ ./node_modules/.bin/gulp

This will install gulp and allow you to run the sample. Gulp will run with with a local deploy configuration. You should see an artifact in the dist folder and a file deployed to your local M2_HOME repository.

Running tests

$ npm test

Contributions

All pull requests and issues are welcome!

Big thanks to Gregers for making the maven-deploy module.