Upload to PGYER

中文文档

Upload Android (.apk), iOS (.ipa) and HarmonyOS (.hap) builds to PGYER for beta distribution, from Pipeline or Freestyle jobs. Maintained by PGYER.

• Uploads from the agent that built the app; nothing is copied to the controller.
• Waits until PGYER has published the build, then returns its download page and QR code.
• Keeps the API key in Jenkins credentials and out of the build log.
• Uses Jenkins' proxy settings, and falls back to PGYER's backup domains when www.pgyer.com is unreachable.

Requires Jenkins 2.479.3 or newer.

1. Copy your API key from https://www.pgyer.com/account/api.
2. In Jenkins, add a Secret text credential holding the key, for example with the ID pgyer-api-key.
3. Optionally, choose it as the default under Manage Jenkins » System » PGYER, so jobs don't have to name it.

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                sh './gradlew assembleRelease'
            }
        }
        stage('Distribute') {
            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}"
                    echo "QR code: ${app.buildQRCodeURL}"
                }
            }
        }
    }
}

The key can also come from the PGYER_API_KEY environment variable:

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

pgyerUpload returns a map with everything PGYER reports about the published build, including:

The build page also shows the download link and QR code.

Add the Upload to PGYER build step or post-build action. As a post-build action it doesn't upload when the build failed.

After the upload, later build steps can use these environment variables: buildShortcutUrl, appPgyerURL, buildQRCodeURL, appQRCodeURL, buildKey, buildName, buildVersion and the other fields of the return value.

Set the job parameter isUploadPgyer to false to skip the upload.

unclassified:
  pgyer:
    credentialsId: pgyer-api-key

Upgrade from Manage Jenkins > Plugins, which also updates the plugins this one depends on if they are too old. Don't install the .hpi file by hand: Jenkins then doesn't update the dependencies, and reports Update required: ... when it starts. If you see that message, update the plugins it lists from the plugin manager. If the plugin manager says that one of them needs a newer version of Jenkins, upgrade Jenkins first.

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

• Builds on agents work: the file is now read and uploaded on the agent.
• The plugin waits up to 10 minutes for PGYER to publish the build, instead of about 15 seconds.
• The API key typed into a 2.x job is still used, but marked as deprecated. Move it to a Secret text credential and choose that credential in the job.
• Pipeline jobs use the new pgyerUpload step.

The upload uses the proxy configured in Jenkins. Java doesn't send Basic credentials when tunnelling HTTPS through a proxy unless the agent JVM is started with -Djdk.http.auth.tunneling.disabledSchemes="".

Report bugs and feature requests at https://github.com/jenkinsci/upload-pgyer-plugin/issues.

MIT