Gulp-cordova-build-android NPM

gulp-cordova-build-android

Build the cordova project for the Android platform.

Installation

npm install --save-dev gulp-cordova-build-android

Usage

const gulp = require('gulp');
const create = require('gulp-cordova-create');
const plugin = require('gulp-cordova-plugin');
const android = require('gulp-cordova-build-android');

gulp.task('build', () => {
    return gulp.src('dist')
        .pipe(create())
        .pipe(plugin('org.apache.cordova.dialogs'))
        .pipe(plugin('org.apache.cordova.camera'))
        .pipe(android())
        .pipe(gulp.dest('apk'));
});

This plugin will build the cordova project for the Android platform.

Because the plugin returns the apk files, you can pipe it to gulp.dest. This will store all the apk files in the apk directory.

Build a release apk

By setting release to true, the plugin will build a release version of the APK. This will create an unsigned apk file.

const gulp = require('gulp');
const create = require('gulp-cordova-create');
const plugin = require('gulp-cordova-plugin');
const android = require('gulp-cordova-build-android');

gulp.task('build', () => {
    return gulp.src('dist')
        .pipe(create())
        .pipe(plugin('org.apache.cordova.dialogs'))
        .pipe(plugin('org.apache.cordova.camera'))
        .pipe(android({release: true}))
        .pipe(gulp.dest('apk'));
});

Sign the apk

To produce a signed apk you need to pass signing options to the plugin. If you pass signing options to the plugin you do not need to specify that it is a release build as the plugin will do a release build automatically

const gulp = require('gulp');
const create = require('gulp-cordova-create');
const plugin = require('gulp-cordova-plugin');
const android = require('gulp-cordova-build-android');

gulp.task('build', () => {
    return gulp.src('dist')
        .pipe(create())
        .pipe(android({storeFile: '/Path/to/key.keystore', keyAlias: 'my_alias'}))
        .pipe(gulp.dest('apk'));
});

When running the build task, it will now ask for the key store password and for the key password.