pgyer plugin

Upload .ipa, .apk and HarmonyOS .hap builds to PGYER from your fastlane lanes.

fastlane add_plugin pgyer

Get your API key at https://www.pgyer.com/account/api and make it available as the PGYER_API_KEY environment variable (for example as a CI secret), so it stays out of your Fastfile:

export PGYER_API_KEY=your_api_key

You can also pass it as pgyer(api_key: ...).

Android, uploading the APK built by gradle in the same lane:

lane :beta do
  gradle(task: "assembleRelease")
  pgyer(update_description: "Fixed the login crash")
end

iOS, uploading the IPA built by gym, protected with an install password:

lane :beta do
  gym(export_method: "ad-hoc")
  pgyer(password: "123456", update_description: "Fixed the login crash")
end

HarmonyOS, uploading a signed .hap (build it first, for example with hvigorw assembleHap):

lane :beta_harmony do
  pgyer(hap: "entry/build/default/outputs/default/entry-default-signed.hap", update_description: "Fixed the login crash")
end

From the command line:

fastlane run pgyer hap:entry/build/default/outputs/default/entry-default-signed.hap

Run fastlane action pgyer to see them in your terminal.

pgyer returns a Hash with the build information from PGYER's buildInfo API (buildKey, buildName, buildVersion, buildVersionNo, buildShortcutUrl, buildQRCodeURL, ...) plus:

The same values are stored in the lane context:

lane :beta do
  gym(export_method: "ad-hoc")
  result = pgyer(update_description: "Fixed the login crash")
  slack(message: "New beta: #{result['appPgyerURL']}")
end

• Error loading plugin 'fastlane-plugin-pgyer' / Unable to activate faraday_middleware / "No actions found": plugin 0.3.x needs Faraday 1 and does not load on fastlane 2.238.0 or later. Upgrade the plugin with bundle update fastlane-plugin-pgyer (or fastlane update_plugins), and make sure fastlane/Pluginfile does not pin an old version.
• API errors (wrong API key, sub-account key, missing real-name verification, uploads disabled, storage full) are printed with the PGYER error code and a hint on how to fix them.
• PGYER is still processing the build after 600 seconds: the upload finished, so the build may still appear in your app list. Raise processing_timeout for very large builds.
• None of the PGYER API servers could be reached: the plugin tries www.pgyer.com, www.xcxwo.com and www.pgyerapp.com in turn. Check your network and proxy (HTTPS_PROXY is honoured), or try doh: true if your DNS blocks these domains.
• The wrong file was uploaded: pass the file explicitly with apk, ipa or hap.

See also the fastlane Plugins Troubleshooting guide.

• An apk, ipa or hap option now always wins over builds in the lane context, and the build type comes from the file extension. ~ in paths is expanded.
• install_type is only sent when you set it. Earlier versions sent 1 (public) on every upload without it, which made password-protected apps public.
• Waiting for PGYER is limited by processing_timeout (default 600 seconds) and survives short network errors.
• oversea accepts true/false and works from PGYER_OVERSEA.
• The fallback servers are only tried on network errors; API errors stop at once and include a hint.
• Request parameters and credentials are no longer printed, and doh mode no longer turns off TLS certificate verification.
• The name of the uploaded file is sent as the download file name unless user_download_file_name is set.
• New: description and processing_timeout options, PGYER_OUTPUT, PGYER_DOWNLOAD_URL and PGYER_QRCODE_URL outputs, PGYER_USER_DOWNLOAD_FILE_NAME.

bundle install
bundle exec rake   # specs and RuboCop

Issues and pull requests are welcome at https://github.com/PGYER/fastlane-plugin-pgyer.