ms-gulp-phonegap-build

THIS PROJECT IS A FORK OF centralway/grunt-phonegap-build UPDATED FOR GULP

gulp-phonegap-build

This is a gulp plugin to upload files to build.phonegap.com and trigger a new build.

Current version & development

The current version is 0.1.4, this project is in BETA and under active development.

##Configuration The files should have the "index.html" and the "Config.xml" in the root level and all required resources below, for example:

├── Config.xml
├── css
│   ├── app.css
│   ├── foundation.min.css
│   ├── lungo.css
│   ├── lungo.icon.brand.css
│   ├── lungo.icon.css
│   └── theme.lungo.css
├── icon.png
├── js
│   ├── app.js
│   ├── controller.js
│   ├── directives.js
│   ├── filters.js
│   ├── services.js
├── images
│   └── background.jpg
├── index.html

Then, some configuration for phonegap-build is needed:

General options

1. appId: The App ID of the application on build.phonegap.com (see details of your app there to get it)
2. user: The email and password or the Github authentication token (all three optional) you log in with on build.phonegap.com. If you leave out your password it will prompt you when gulp runs.
3. timeout: (optional, default: 60 seconds) a timeout. You may need to increase this value if you are trying to upload a large app or have a slow connection.
4. pollRate: (optional, default: 15 seconds) The rate at which the plugin will poll when checking to see if the apps have been built.
5. tag: (optional, default: master) a tag or branch name. You can add a tag or branch name to pull the code from.

For repository-based applications (using a github repository)

1. isRepository: True to set the build method to "pull from repository"

Target platforms

1. platforms: array of the target platforms to build. For example:

    platforms: ['ios', 'android']
   

Note: there is a bug in PhoneGap API that don't allow to trigger build until target platforms are specified.

When unlocking keys

1. keys: A map of platform name [ios, android, ...] to parameters required to unlock the keys. For example:

   keys: {
     ios: { "password": "foobar" },
     android: { "key_pw": "foobar", "keystore_pw": "foobar" }
   }
   

When downloading apps

1. download: A map of platform name [ios, android, ...] to path to save the app to. For example:

   download: {
     ios: 'dist/ios.ipa',
     android: 'dist/android.apk'
   }
   

That's all. Once you configured the build-phonegap, you can run

$ gulp phonegap-build

to create a new build. Note: This is a multitask, so you can specify different configurations for it (e.g. test and production). You need to specify at least one configuration Here is an example for a gulpfile.js:

var gulp = require('gulp');
var phonegapBuild = require('gulp-phonegap-build');

// {dot: true} here to inlude .pgbomit file in zip
gulp.task('phonegap-build', function () {
    gulp.src('dist/**/*', {dot: true})
        .pipe(phonegapBuild({
          "isRepository": "true",
          "appId": "9876",
          "user": {
            "token": "ABCD123409876XYZ"
          },
          "tag": "deploy" //tag or branch name
        }));
});

gulp.task('phonegap-build-debug', function () {
    gulp.src('dist/**/*', {dot: true})
        .pipe(phonegapeBuild({
          "appId": "1234",
          "user": {
            "email": "[e-mail]",
            "password": "yourPassw0rd"
          },
          "tag": "deploy" //tag or branch name
        }));
});

gulp.task('default', ['phonegap-build']);