The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Android Signing Plugin

signAndroidApks: Sign Android APKs

  • androidHome (optional)
    • Type: String
  • apksToSign (optional)
    • Type: String
  • archiveSignedApks (optional)
    • Type: boolean
  • archiveUnsignedApks (optional)
    • Type: boolean
  • keyAlias (optional)
    • Type: String
  • keyStoreId (optional)
    • Type: String
  • signedApkMapping (optional)
      Nested Choice of Objects
    • unsignedApkNameDir
      • unsignedApkSibling
      • skipZipalign (optional)
        • Type: boolean
      • zipalignPath (optional)
        • Type: String

      signAndroidApks: Sign Android APKs

      • androidHome (optional)
        Override the path of the Android SDK installation this build step should use to find the zipalign tool. You can also set the ANDROID_HOME environment variable in your Jenkins system or node configuration. E.g., /usr/local/android-sdk.
        • Type: String
      • apksToSign (optional)
        An Ant-style glob, or multiple comma-separated globs, selecting the APK files relative to the workspace. For example, myApp/build/outputs/apk/myApp-unsigned.apk or **/*-unsigned.apk or app1/**/*-unsigned.apk, app2/**/*-unsigned.apk.
        • Type: String
      • archiveSignedApks (optional)
        Check this option to add all signed APKs this build step generates to the build's archived artifacts. If you don't want this step to archive the signed APK artifacts, downstream build steps can access signed APKs in the workspace at paths like SignApksBuilder-out/myApp-unsigned.apk/myApp-signed.apk, where myApp-unsigned.apk is a directory named for the input unsigned APK.
        • Type: boolean
      • archiveUnsignedApks (optional)
        Check this option to add all input unsigned APKs to the build's archived artifacts. These will be the APK files selected with glob pattern(s) of the APKs to Sign setting.
        • Type: boolean
      • keyAlias (optional)
        The entry name of the private key/certificate chain you want to use to sign your APK(s). This entry must exist in the key store credentials the Key Store ID references. If your key store contains only one key entry, which is the most common case, you can leave this field blank.
        • Type: String
      • keyStoreId (optional)
        The ID of a certificate credential. This build step expects the referenced certificate credential to be a password-protected PKCS12 file containing a key protected by the same password. See this plugin's script if you need help creating such a key store to add to Jenkins, or Google how to convert your Android release key to a PKCS12 file.
        • Type: String
      • signedApkMapping (optional)
          Nested Choice of Objects
        • unsignedApkNameDir
          • unsignedApkSibling
          • skipZipalign (optional)
            Skip the Zipalign step of signing the APK(s). This is primarily for the case of signing debug APKs, for which the zipalign command fails.
            • Type: boolean
          • zipalignPath (optional)
            Override the full path of the Android zipalign executable this build step should use to align the target APKs. You can also set the ANDROID_ZIPALIGN environment variable in your Jenkins system or node configuration. E.g., /opt/android-tools/bin/zipalign
            • Type: String

          Was this page helpful?

          Please submit your feedback about this page through this quick form.

          Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

              


          See existing feedback here.