Pgyer Docs
CI/CD & Dev Tools

Upload via the Jenkins Plugin

Install, configure, and use the official Pgyer Jenkins plugin — upload ipa/apk to Pgyer automatically and expose the response as Jenkins global variables.

The official Pgyer Jenkins plugin configures the upload step through a form, publishes ipa/apk builds to Pgyer automatically, and exposes the response as Jenkins global variables that later build steps can reference.

Installation

Manual Install

  1. Download the plugin upload-pgyer.hpi: plugin installer.
  2. In Jenkins, go to Manage Jenkins → Plugin Manager → Advanced, find Deploy Plugin, click Choose File, select the file you just downloaded, and click Deploy.

From the Plugin Registry

In Jenkins, go to Manage Jenkins → Manage Plugins → Available → Search, enter Upload to pgyer, and click Install.

Usage

On the Job configuration page, add a upload to pgyer with apiV2 step under Post-build Actions:

Add the plugin

Once added, the configuration UI looks like this:

Plugin config

Parameters

ParameterRequiredDescription
pgyer api_keyYesYour Pgyer api_key
scandirYesDirectory that contains the ipa/apk
file widcardYesUpload wildcard, e.g. android or ios; defaults to android
buildTypeYesType of app being uploaded
installTypeNoInstall method: 1, 2, or 3; defaults to 1. 1: public; 2: password; 3: invite
passwordNoInstall password
updateDescriptionNoRelease notes

Build Log and Return Variables

During the build, the plugin prints upload progress to the log:

Pgyer upload log

On success, the plugin injects the values returned by Pgyer as Jenkins global variables. Later build steps can reference them by name, e.g. ${appBuildURL}:

Using Pgyer's return values in other steps

See the upload API docs for the full list of return fields.

On this page