Upload via the Jenkins Plugin

The official Pgyer Jenkins plugin, Upload to PGYER, uploads Android (.apk), iOS (.ipa) and HarmonyOS (.hap) packages to Pgyer after your build, waits until the build is published, and shows its download page and QR code on the build page. It works in both Pipeline and Freestyle jobs: the package is uploaded from the node that built it, and the API key is kept in Jenkins credentials and never appears in the build log.

To compare the API, CLI, CI/CD plugins and other ways to upload, see Automated Uploads and CI/CD Integration.

Overview

Install the plugin

1. In Jenkins, go to Manage Jenkins → Plugins → Available plugins.
2. Search for pgyer, select Upload to PGYER and click Install.
3. When the installation finishes, search for pgyer under Installed plugins to check that the plugin is enabled:

If Jenkins can't reach the plugin site, install the plugin manually:

1. Download the latest upload-pgyer.hpi from the releases page.
2. Go to Manage Jenkins → Plugins → Advanced settings, choose the downloaded file under Deploy Plugin and click Deploy.

Add your API key

1. Sign in to Pgyer and copy your API key from the API information page.
2. In Jenkins, go to Manage Jenkins → Credentials → System → Global credentials and click Add Credentials.
3. Set Kind to Secret text, paste the API key into Secret, set ID to pgyer-api-key (the examples on this page use this ID) and click Create.

If most of your jobs use the same API key, set it as the default under Manage Jenkins → System → PGYER, so jobs don't have to choose a credential:

Pipeline jobs

Call pgyerUpload after the build, for example:

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                sh './gradlew assembleRelease'
            }
        }
        stage('Distribute to PGYER') {
            steps {
                script {
                    def app = pgyerUpload file: 'app/build/outputs/apk/release/*.apk',
                                          credentialsId: 'pgyer-api-key',
                                          updateDescription: "Build #${env.BUILD_NUMBER}"
                    echo "Download page: ${app.appPgyerURL}"
                }
            }
        }
    }
}

If you write the script in Jenkins itself, paste it into Pipeline → Script in the job configuration:

You can also generate the call with the built-in Pipeline Syntax page: click Pipeline Syntax on the job page, choose pgyerUpload: Upload a build to PGYER as the Sample Step, fill in the fields and click Generate Pipeline Script.

Parameters

Return value

pgyerUpload returns a map with everything Pgyer reports about the published build. The most useful fields are:

Pass them to later steps, for example to post the download link to a team chat. For all fields, see the upload API.

Providing the API key through an environment variable

If you manage credentials with withCredentials, put the API key in the PGYER_API_KEY environment variable and pgyerUpload reads it:

withCredentials([string(credentialsId: 'pgyer-api-key', variable: 'PGYER_API_KEY')]) {
    pgyerUpload file: 'build/*.ipa'
}

Freestyle jobs

1. Open the job configuration, click Add build step under Build Steps and choose Upload to PGYER:

   

2. Choose the credential you added under API key, keep Directory as ${WORKSPACE}, and set File to the path of your package, such as app/build/outputs/apk/release/*.apk:

   

3. To set the install type, update description and more, click Advanced. Then save the job.

Upload to PGYER is also available as a post-build action. As a post-build action it doesn't upload when the build failed.

The Advanced options match the Pipeline parameters:

Using the result in later steps

After the upload, the plugin sets environment variables for the following build steps, such as $appPgyerURL (download page), $buildQRCodeURL (QR code image), $buildShortcutUrl and $buildVersion. The names match the fields of the return value.

For example, add an "Execute shell" step after the upload:

echo "Download page: $appPgyerURL"

To skip the upload, add a job parameter isUploadPgyer and set it to false.

Check the result

The build log shows the upload progress, the published build and its download page:

The build page shows the download link and QR code, so testers can scan it to install:

The download page opened by the QR code:

Upgrading from 2.x

Jobs configured with version 2.x keep working after the upgrade without changes, including the environment variables they set and the isUploadPgyer and uploadPgyerTimeout variables they read. What changes:

• Jobs that build on agents can upload: the plugin reads and uploads the package on the agent.
• The plugin waits up to 10 minutes for Pgyer to publish the build, so "upload success but synchronizing data fail" no longer happens.
• HarmonyOS .hap packages are supported, and the build type is detected from the file extension.
• Downloads keep the original file name of the package.
• Pipeline jobs should use the pgyerUpload step.

An API key typed into a 2.x job still works, but is marked as deprecated:

Create a credential as described in Add your API key, choose it under API key, then click Change Password to clear the deprecated key and save the job.

FAQ

The upload fails with an error code

Uploading through a proxy

The plugin uses the HTTP proxy configured in Jenkins, and tries Pgyer's backup domains when www.pgyer.com can't be reached.

Feedback

The plugin is open source. Report issues and suggestions on GitHub.