Gulp Plugin for Adobe PhoneGap Build

Common errors

• Error: read ECONNRESET

  cause Network connection issues, server-side closure, or the PhoneGap Build service being unavailable.
  fix This error, particularly after October 2020, likely indicates that the `build.phonegap.com` service is no longer operational. The plugin cannot recover from this, and the underlying service is permanently offline.

• Error: access denied

  cause Incorrect authentication credentials (user, password, or token) or the PhoneGap Build service denying access due to its shutdown.
  fix Prior to the shutdown, verify `user` and `appId` configurations. After October 2020, this error confirms the service is defunct, and the plugin is no longer usable.

Warnings

• breaking The Adobe PhoneGap Build cloud service, which this Gulp plugin integrates with, was officially discontinued on October 1, 2020. Consequently, `gulp-phonegap-build` is entirely non-functional as its target API no longer exists. There is no direct replacement service under the PhoneGap brand.
  Fix: Migrate to alternative cross-platform development solutions like Apache Cordova (for local builds), Ionic Appflow, React Native, Flutter, or Progressive Web Apps.
• gotcha Even when the service was active, omitting the `platforms` array in the configuration would prevent builds from being triggered due to an undocumented quirk in the PhoneGap API. This was a common source of confusion.
  Fix: Always specify `platforms: ['ios', 'android']` (or other relevant platforms) in the plugin configuration to ensure builds are triggered. (This is now moot due to service shutdown.)
• gotcha When sourcing files for upload using `gulp.src`, the `{dot: true}` option was crucial to include hidden configuration files (e.g., `.pgbomit`) that PhoneGap Build might have relied upon. Forgetting this option could lead to unexpected build failures or misconfigurations on the PhoneGap Build server.
  Fix: Ensure `gulp.src('path/to/files/**/*', {dot: true})` is used to include all necessary files, including dotfiles. (This is now moot due to service shutdown.)

Install

• npm install gulp-phonegap-build npm
• yarn add gulp-phonegap-build yarn
• pnpm add gulp-phonegap-build pnpm

Imports

• phonegapBuild
  wrong:

  import phonegapBuild from 'gulp-phonegap-build';

  correct:

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

  The plugin is designed for CommonJS environments typical of Gulpfiles from its era (Node.js >= 0.8.0). ESM `import` syntax is not supported and will not work.

Quickstart

This quickstart demonstrates how to define a Gulp task using `gulp-phonegap-build` to upload files, trigger a build for specific platforms, and download the resulting app binaries, configured with a token for authentication. Note that this code will no longer function due to the PhoneGap Build service shutdown.

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

// NOTE: This plugin is non-functional as the Adobe PhoneGap Build service was discontinued on Oct 1, 2020.
// The example below demonstrates its intended usage for historical context.

gulp.task('phonegap-build-example', function () {
    gulp.src('dist/**/*', {dot: true}) // {dot: true} is important to include files like .pgbomit
        .pipe(phonegapBuild({
          "isRepository": false, // Set to true if using a GitHub repository
          "appId": "9876",       // Replace with your actual PhoneGap Build App ID
          "user": {
            "token": "ABCD123409876XYZ" // Replace with your PhoneGap Build authentication token
          },
          "platforms": ['ios', 'android'], // Required to trigger builds due to API quirk
          "download": {
            "ios": 'dist/ios.ipa',
            "android": 'dist/android.apk'
          }
        }))
        .on('error', function(err) {
            console.error('PhoneGap Build task failed:', err.message);
        });
});

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