{jenkins-plugin-info:google-play-android-publisher} |
Enables Jenkins to upload Android apps (APK files) and related info to Google Play. |
Jenkins version 2.60.3 or newer is required.
For the initial setup only, you must have access to the Google account which owns the Google Play publisher account.
This is required to enable API access from Jenkins to your Google Play account.
Note that having admin access is not enough; you need the account owner.
You can see who the account owner is under Settings → User accounts & rights in the Google Play developer console.
The following initial setup process is demonstrated in this video: https://www.youtube.com/watch?v=txdPSJF94RM
(note that Google has changed the Google API Console (twice) since this video was recorded; steps 3–13 in the "Create Google service account" section below have the updated info)
Install this plugin via the Jenkins plugin manager.
Or if installing the plugin via other means, ensure that the prerequisite Google OAuth Plugin, Token Macro Plugin and their dependencies are also installed.
To enable automated access to your Google Play account, you must create a service account:
Jenkins now has the required credentials and permissions in order to publish to Google Play.
Once you've set up a job (see the next section) and confirmed that uploading works, either delete the downloaded JSON file or ensure that it's stored somewhere secure.
The following job setup process is demonstrated in this video: https://www.youtube.com/watch?v=iu-bLY9-jkc
**/*-release.apk pattern, or a comma-separated list of filenames, relative to the root of the workspaceYou can optionally add up to two expansion files for each APK being uploaded.
A list of expansion files can be specified in the same way as APKs, though note that they must be named in the format [main|patch].<expansion-version>.<package-name>.obb.
See the inline help for more details.
If you have already uploaded an app to the alpha track (for example), you can later use Jenkins to re-assign that version to the beta or production release track.
Under the "Build" section of the job configuration, add the "Move Android APKs to a different release track" build step and configure the new release track.
You can tell Jenkins which APKs to be moved by either entering the APK version codes directly, or by providing the APK files, from which the plugin will read the application ID and version codes for you.
As of version 1.5, this plugin supports the Pipeline Plugin syntax. You can generate the required Pipeline syntax via the Snippet Generator, but some examples follow.
Note that you should avoid using these steps in a parallel block, as the Google Play API only allows one concurrent "edit session" to be open at a time.
The androidApkUpload step requires at least the Google Play credential ID, a list of APK(s) to upload, and the track to assign them to:
androidApkUpload googleCredentialsId: 'My Google Play account', apkFilesPattern: '**/*.apk', trackName: 'production' |
Uploading the ProGuard mapping file(s) to be associated with the APK(s) just requires one more more patterns in addition:
androidApkUpload googleCredentialsId: 'My Google Play account', apkFilesPattern: '**/*.apk',
deobfuscationFilesPattern: '**/mapping.txt', trackName: 'production'
|
Performing a staged rollout requires the rollout percentage as a string; the percentage sign is optional:
androidApkUpload googleCredentialsId: 'GP', apkFilesPattern: '**/*.apk', trackName: 'production', rolloutPercentage: '50%' |
Adding "recent changes" text requires specifying a list:
androidApkUpload googleCredentialsId: 'GP', apkFilesPattern: '**/*.apk', trackName: 'alpha',
recentChangeList: [
[language: 'en-GB', text: "Please test the changes from Jenkins build ${env.BUILD_NUMBER}."],
[language: 'de-DE', text: "Bitte die Änderungen vom Jenkins Build ${env.BUILD_NUMBER} testen."]
]
|
To upload expansion files, reusing those from the previous upload where possible:
androidApkUpload googleCredentialsId: 'GP', apkFilesPattern: '**/*.apk', trackName: 'production',
expansionFilesPattern: '**/patch.obb',
usePreviousExpansionFilesIfMissing: true
|
The androidApkMove step requires at least the Google Play credential ID and the track to move APK(s) to, plus either an application ID and version code(s), or APK file(s) to read this information from.
Moving APKs from alpha to beta, specifying the application ID and version codes:
androidApkMove googleCredentialsId: 'My Google Play account',
applicationId: 'com.example.app',
versionCodes: '1050, 2050, 3050',
trackName: 'beta'
|
Moving APKs from beta to staged rollout, specifying the application ID and version codes via the uploaded APKs:
androidApkMove googleCredentialsId: 'My Google Play account',
fromVersionCode: false,
apkFilesPattern: '**/*.apk',
trackName: 'production',
rolloutPercentage: '5'
|
If you're a user of expansion files, especially if you use multiple APKs, it would be helpful to know how you normally use expansion files, and whether what the plugin provides is adequate.
Do you normally have separate main/patch expansion files for each of the APKs, or is it more common for all APKs to share the same expansion files?
Currently the former case isn't possible when trying to re-use expansion files from existing APKs (without having you explicitly specify which expansion files from which old APKs should be re-used with which newly-uploaded APKs).
Let me know via the maintainer email at the top of the page!
Error messages from the plugin (many of which come directly from the Google Play API) should generally be self-explanatory.
If you're having trouble getting a certain config to work, try uploading the same APKs manually to Google Play. There you'll likely see the reason for failure, e.g. a version code conflict or similar.
Otherwise, please file a bug report or send an email with details, including the build console log output; see info box at the top of the page.
Some known error messages and their solutions are shown below:
This means that the Google service account does not have permission to make the changes that you requested.
Make sure that you followed the setup instructions above, and confirm that the service account you are using in this Jenkins job has the appropriate permissions for the app that you are trying to change.
Unfortunately, the Google Play API sometimes is not particularly reliable, and will throw generic server errors for no apparent reason.
In these cases you can try running your build again, or wait a few hours before retrying, if the problem persists.
Please also consider contacting Google Play Developer Support to help make them aware that people use the Google Play API, and that it should preferably work in a reliable manner.
This plugin already recognises some temporary Google Play API server problems and works around them; more workarounds may be added in future, e.g. automatically retrying when a generic server error is encountered.
If you see this error message, look further down the error log to see what is causing it. Below are a couple of common causes:
Ensure that the time is correctly synchronised on the build machine, and then try again.
This likely means your build machine is behind an HTTP proxy.
In this case, you should set up Jenkins as documented on the JenkinsBehindProxy page.
This plugin only makes secure (HTTPS) requests, so you need to make sure that the -Dhttps.proxyHost=<hostname> and -Dhttps.proxyPort=<port> Java properties are set when starting Jenkins. Add the appropriate http versions of those flags too, if unsecured HTTP requests also need to go through the proxy.
Using the build flavours feature of the Android Gradle build system, it's possible to have a single Android build which produces multiple APKs, each with a different application ID.
e.g. You could have application IDs "com.example.app" and "com.example.app.pro" for free and paid versions.
As these will often be built in a single Jenkins job, people have wondered why this plugin will refuse to upload APKs with differing application IDs in a single freestyle job.
However, as far as Google Play is concerned, these are completely separate apps. This is correct and, as such, they should be uploaded in separate Jenkins builds: one per application ID.
If the plugin did allow this and you were to attempt to upload, say three, completely different APKs in one Jenkins build, this would require opening and committing three separate "edit sessions" with the Google Play API. If any one of these were to fail — maybe because of an invalid APK, versionCode conflict, or due to an API failure (which, unfortunately, is not uncommon with the Google Play API) — you would end up with your Google Play account in an inconsistent state. Your Jenkins build would be marked as failed, but one or more applications will have actually been uploaded and published to Google Play, and you would have to fix the situation manually. Also, you would not be able to simply re-run the build, as it would fail due to already-existing APKs.
The best practice in this case would be to have one job that builds the different flavours (i.e. the APKs with different application IDs) and then, if the build is successful, it would archive the APKs and start multiple "downstream" Jenkins builds which individually publish each of the applications.
This can be achieved, for example, with the Parameterized Trigger Plugin and the Copy Artifacts Plugin, i.e. the "upload" job could be generic, and would receive the APK information via parameter.
Alternatively, if you have version 1.5 of this plugin, and use the Pipeline Plugin, you should be able to use the androidApkUpload step multiple times within a single build.
${FILE, path="changes-en.txt"}, to read a changelog from the workspace and use its contents as release notes when uploading an APK to Google Play