steps-sign-apk

command module

v0.0.0-...-8c96369 Latest Latest Go to latest Published: Nov 29, 2022 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bitrise-steplib/steps-sign-apk

Links

Open Source Insights

README ¶

Android Sign

Signs your APK or Android App Bundle before uploading it to Google Play Store.

Description

Once you have uploaded your keystore file and provided your keystore credentials on the Code Signing tab of the Workflow Editor, the Android Sign Step signs your APK digitally. Bitrise assigns Environment Variables to the uploaded file and credentials, and uses those in the respective fields of the Android Sign Step. Once the Step runs, it produces a signed APK or App Bundle which will be used as the input value of the App file path field in the Google Play Deploy Step.

Configuring the Step

Add the Android Sign Step after a build Step in your deploy workflow.
Upload the keystore file to the Upload file field on the Code Signing tab.
Provide your keystore password, keystore alias and private key password to the relevant fields on the Code Signing tab.
Run your build.

Troubleshooting

Make sure you have the Android Sign Step right after a build Steps but before Deploy to Google Play Step in your deploy workflow. If you wish to get your Android project signed automatically, use the Android Sign Step and do not set any gradle task for the signing, otherwise, the Step will fail.

Useful links

🧩 Get started

Add this step directly to your workflow in the Bitrise Workflow Editor.

You can also run this step directly with Bitrise CLI.

Examples

Build an Android App Bundle:

workflows:
  release:
    envs:
    - PROJECT_LOCATION: .
    - MODULE: app
    - VARIANT: release
    # If the Android keystore is configured in the workflow editor, BITRISEIO_ANDROID_KEYSTORE* envs will be set automatically
    - BITRISEIO_ANDROID_KEYSTORE_URL: $BITRISEIO_ANDROID_KEYSTORE_URL
    - BITRISEIO_ANDROID_KEYSTORE_PASSWORD: $BITRISEIO_ANDROID_KEYSTORE_PASSWORD
    - BITRISEIO_ANDROID_KEYSTORE_ALIAS: $BITRISEIO_ANDROID_KEYSTORE_ALIAS
    - BITRISEIO_ANDROID_KEYSTORE_PRIVATE_KEY_PASSWORD: $BITRISEIO_ANDROID_KEYSTORE_PRIVATE_KEY_PASSWORD
    
    steps:
    - activate-ssh-key:
        run_if: '{{getenv "SSH_RSA_PRIVATE_KEY" | ne ""}}'
    - git-clone: {}
    - install-missing-android-tools:
        inputs:
        - gradlew_path: $PROJECT_LOCATION/gradlew
    - android-build:
        inputs:
        - project_location: $PROJECT_LOCATION
        - module: $MODULE
        - variant: $VARIANT
        - build_type: aab

Sign the App Bundle:

    - sign-apk:
        inputs:
        - use_apk_signer: false

Deploy the signed App Bundle to Bitrise:

    - deploy-to-bitrise-io: {}

⚙️ Configuration

Inputs

Key	Description	Flags	Default
`android_app`	Path(s) to the build artifact file to sign (`.aab` or `.apk`). You can provide multiple build artifact file paths separated by `\|` character. Format examples: - `/path/to/my/app.apk` - `/path/to/my/app1.apk\|/path/to/my/app2.apk\|/path/to/my/app3.apk` - `/path/to/my/app.aab` - `/path/to/my/app1.aab\|/path/to/my/app2.apk\|/path/to/my/app3.aab`	required	`$BITRISE_APK_PATH\n$BITRISE_AAB_PATH`
`keystore_url`	For remote keystores you can provide any download location (e.g. `https://URL/TO/keystore.jks`). For local keystores provide file path url. (e.g. `file://PATH/TO/keystore.jks`).	required, sensitive	`$BITRISEIO_ANDROID_KEYSTORE_URL`
`keystore_password`		required, sensitive	`$BITRISEIO_ANDROID_KEYSTORE_PASSWORD`
`keystore_alias`		required, sensitive	`$BITRISEIO_ANDROID_KEYSTORE_ALIAS`
`private_key_password`	If key password equals to keystore password (not recommended), you can leave it empty. Otherwise specify the private key password.	sensitive	`$BITRISEIO_ANDROID_KEYSTORE_PRIVATE_KEY_PASSWORD`
`page_align`	If enabled, it tells zipalign to use memory page alignment for stored shared object files. - `automatic`: Enable page alignment for .so files, unless atribute `extractNativeLibs="true"` is set in the AndroidManifest.xml - `true`: Enable memory page alignment for .so files - `false`: Disable memory page alignment for .so files	required	`automatic`
`use_apk_signer`	Indicates if the signature should be done using `apksigner` instead of `jarsigner`.	required	`false`
`signer_scheme`	If set, enforces which Signature Scheme should be used by the project. - `automatic`: The tool uses the values of `--min-sdk-version` and `--max-sdk-version` to decide when to apply this Signature Scheme. - `v2`: Sets `--v2-signing-enabled` true, and determines whether apksigner signs the given APK package using the APK Signature Scheme v2. - `v3`: Sets `--v3-signing-enabled` true, and determines whether apksigner signs the given APK package using the APK Signature Scheme v3. - `v4`: Sets `--v4-signing-enabled` true, and determines whether apksigner signs the given APK package using the APK Signature Scheme v4. This scheme produces a signature in an separate file (apk-name.apk.idsig). If true and the APK is not signed, then a v2 or v3 signature is generated based on the values of `--min-sdk-version` and `--max-sdk-version`.	required	`automatic`
`debuggable_permitted`	Whether to permit signing `android:debuggable="true"` APKs. Android disables some of its security protections for such apps.	required	`true`
`output_name`	If is empty then the output name is `app-release-bitrise-signed`. Else it's the specified name. Do not add the file extension here.
`verbose_log`	Enable verbose logging?	required	`false`
`apk_path`	This input is deprecated and will be removed on 20 August 2019, use `App file path` input instead! Path(s) to the build artifact file to sign (`.aab` or `.apk`). You can provide multiple build artifact file paths separated by `\|` character. Deprecated, use `android_app` instead. Format examples: - `/path/to/my/app.apk` - `/path/to/my/app1.apk\|/path/to/my/app2.apk\|/path/to/my/app3.apk` - `/path/to/my/app.aab` - `/path/to/my/app1.aab\|/path/to/my/app2.apk\|/path/to/my/app3.aab`	required

Outputs

Environment Variable	Description
`BITRISE_SIGNED_APK_PATH`	This output will include the path of the signed APK. If the build generates more than one APK this output will contain the last one's path.
`BITRISE_SIGNED_APK_PATH_LIST`	This output will include the paths of the generated APKs If multiple APKs are provided for signing the output paths are separated with `\|` character, for example, `app-armeabi-v7a-debug.apk\|app-mips-debug.apk\|app-x86-debug.apk`
`BITRISE_SIGNED_AAB_PATH`	This output will include the path of the signed AAB. If the build generates more than one AAB this output will contain the last one's path.
`BITRISE_SIGNED_AAB_PATH_LIST`	This output will include the paths of the generated AABs. If multiple AABs are provided for signing the output paths are separated with `\|` character, for example, `app-armeabi-v7a-debug.aab\|app-mips-debug.aab\|app-x86-debug.aab`
`BITRISE_APK_PATH`	This output will include the path(s) of the signed APK(s). If multiple APKs are provided for signing the output paths are separated with `\|` character, for example, `app-armeabi-v7a-debug.apk\|app-mips-debug.apk\|app-x86-debug.apk`
`BITRISE_AAB_PATH`	This output will include the path(s) of the signed AAB(s). If multiple AABs are provided for signing the output paths are separated with `\|` character, for example, `app-armeabi-v7a-debug.aab\|app-mips-debug.aab\|app-x86-debug.aab`