# gulp-maven-deploy

> Simple gulp plugin for the maven-deploy module

Latest version **1.0.2** (published 2018-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-maven-deploy
pnpm add gulp-maven-deploy
yarn add gulp-maven-deploy
bun add gulp-maven-deploy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-04-05 |
| First published | 2014-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 43.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Michael van Engelshoven |
| Maintainers | leftiefriele, micha149 |
| Keywords | maven, gulp, gulp-plugin, deploy |

## Links

- npm: https://www.npmjs.com/package/gulp-maven-deploy
- Repository: https://github.com/micha149/gulp-maven-deploy
- Homepage: https://github.com/micha149/gulp-maven-deploy#readme
- Issues: https://github.com/micha149/gulp-maven-deploy/issues
- npm.io page: https://npm.io/package/gulp-maven-deploy

## Dependencies (6)

- [temp](https://npm.io/package/temp.md) ^0.8.3
- [async](https://npm.io/package/async.md) ^2.0.1
- [vinyl](https://npm.io/package/vinyl.md) ^1.1.1
- [through2](https://npm.io/package/through2.md) ^2.0.1
- [maven-deploy](https://npm.io/package/maven-deploy.md) ^1.4.0
- [lodash.assign](https://npm.io/package/lodash.assign.md) ^4.0.8

## Recent versions

- 1.0.2 (latest) — 2018-04-05
- 1.0.1 — 2016-08-30
- 1.0.0 — 2016-08-29
- 1.0.0-beta.5 — 2016-05-01
- 1.0.0-beta.4 — 2016-04-29
- 1.0.0-beta.3 — 2016-04-29
- 1.0.0-beta.2 — 2016-04-29
- 1.0.0-beta.1 — 2016-04-29
- 0.2.2 — 2016-03-04
- 0.2.1 — 2016-02-22
- 0.2.0 — 2015-06-09
- 0.1.5 — 2015-06-03
- 0.1.4 — 2015-06-03
- 0.1.3 — 2015-02-20
- 0.1.2 — 2014-08-29
- … 4 more at https://npm.io/package/gulp-maven-deploy/versions

## README

gulp-maven-deploy
=================

A [Gulp](//gulpjs.com/) wrapper for the [maven-deploy](https://www.npmjs.org/package/maven-deploy) module. Enables you to have projects which are built with Gulp, but deploys to Maven repositories.

[![Build Status](https://travis-ci.org/micha149/gulp-maven-deploy.svg?branch=master)](https://travis-ci.org/micha149/gulp-maven-deploy)
[![Dependency Status](https://david-dm.org/micha149/gulp-maven-deploy.svg)](https://david-dm.org/micha149/gulp-maven-deploy)
[![devDependency Status](https://david-dm.org/micha149/gulp-maven-deploy/dev-status.svg)](https://david-dm.org/micha149/gulp-maven-deploy#info=devDependencies)

[![NPM](https://nodei.co/npm/gulp-maven-deploy.png?stars=true&downloads=true)](https://npmjs.org/package/gulp-maven-deploy)

All the samples below require a basic understanding of [Gulp](//gulpjs.com/) and [Maven](http://maven.apache.org/). Please look at the documentation for those projects for details. This readme refers to 1.x versions. If you are still using the 0.x versions, have a look into the [0.x support branch](https://github.com/micha149/gulp-maven-deploy/tree/support/0.x).

## 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

```javascript
var gulp = require('gulp'),
    maven = require('gulp-maven-deploy');
    zip = require('gulp-zip');

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

A task running a local Maven install:

```javascript
var gulp = require('gulp'),
    maven = require('gulp-maven-deploy'),
    zip = require('gulp-zip');

gulp.task('deploy-local', function() {
    return gulp.src('.')
        .pipe(zip('my-artifact.war'))
        .pipe(maven.install({
            'groupId': 'com.mygroup',
        }))
});
```

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.

## Upgrading from 0.x to 1.x

With `gulp-maven-deploy` version 1.0.0 we want to go one more step into the
direction of a well performing gulp plugin. Following the single responsibility
principle this plugin will only perform the deploy part in the future.

- Implement a packaging logic for your files like [gulp-zip](https://github.com/sindresorhus/gulp-zip)
- Remove the additional config level from `options = {config: { ... }}` to `options = { ... }`
- Remove `artifactId` and `type` from config. They are now extracted from the file name. To influence
them, rename the file in the gulp stream before piping it to `gulp-maven-deploy`
- Callback function was removed. Use stream events `finish` or `error` to get notified about successful or unsuccessful deploys

## Example project

There is a complete example project if you checkout the [example](./example) directory.

    $ cd example
    $ 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
by default. You should see an artifact deployed to your local `M2_HOME` repository.

## Running tests

    $ npm test

## Contributions

All pull requests and issues are welcome!

Big thanks to [Gregers](https://github.com/gregersrygg) for making the [maven-deploy](https://www.npmjs.org/package/maven-deploy) module.

---
_Source: https://npm.io/package/gulp-maven-deploy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._