README

gulp-jsforce-deploy

A gulp plugin for deploying Salesforce package, using JSforce's Metadata API feature. As it is implemented purely in Node.js, you do not have to setup Force.com Migration Tool (Ant, Java) anymore.

Setup

$ npm init
$ npm install gulp gulp-zip gulp-jsforce-deploy --save-dev

Example

Project Directory

├── gulpfile.js
├── package.json
└── pkg
    ├── classes
    ├── objects
    ├── package.xml
    ├── pages
    └── staticresources

gulpfile.js

var gulp = require('gulp');
var zip = require('gulp-zip');
var forceDeploy = require('gulp-jsforce-deploy');

gulp.task('deploy', function() {
  gulp.src('./pkg/**', { base: "." })
    .pipe(zip('pkg.zip'))
    .pipe(forceDeploy({
      username: process.env.SF_USERNAME,
      password: process.env.SF_PASSWORD
      //, loginUrl: 'https://test.salesforce.com'
      //, pollTimeout: 120*1000
      //, pollInterval: 10*1000
      //, version: '33.0'
    }));
});

Deploy

$ SF_USERNAME=username@example.com SF_PASSWORD=yourpassword gulp deploy

or if you have foreman installed, create .env file with above credential information, and execute :

$ foreman run gulp deploy

Usage no npm install needed!