Autoplay

Additional

Language
Kotlin
Version
3.0.0-alpha1 (Nov 28, 2018)
Created
Jul 15, 2018
Updated
Nov 28, 2018
Owner
Sergej Shafarenka (beworker)
Contributors
Sergej Shafarenka (beworker)
ipcjs
2
Activity
Badge
Generate
Download
Source code

Blurb

Autoplay

Gradle plugin for publishing Android artifacts to Google Play.

Features

  • Autoplay is optimized for CI/CD usage:

    • it does not trigger assembly task automatically - you can reuse build artifacts from previous build steps;
    • it accepts JSON key as base64-encoded string from external secure variables.
  • Autoplay is developer friendly:

    • it does not require storing any dummy keys in source control;
    • it has a single publish task for uploading artifacts (apk or app bundle) and release notes.
  • Autoplay is reliable and future-proof:

    • it has clean and concise implementation, which is easy to understand, extend and fix;
    • it's covered by unit tests;
    • it's built using latest tools and API's.

Usage

In the main build.gradle

buildscript {
  repositories {
    google()
    jcenter()  
  }
  dependencies {
    classpath "de.halfbit:autoplay:<version>"
  }
}

Latest published version can be found at

Gradle compatibility

Gradle Version Autoplay Version
4.8.x 1.3.0
4.10.x 2.3.0
5.0.x 3.0.0-alpha1

Publishing apk

In the application module's build.gradle

apply plugin: 'com.android.application'
apply plugin: 'android-autoplay'

autoplay {
    track "internal"
    secretJsonBase64 project.hasProperty('SECRET_JSON') ? project.property('SECRET_JSON') : ''
}

Execute ./gradlew tasks and you will see a new publishing task publishApk<BuildVariant> in the list. Autoplay adds this task for each build variant of release type. For a project without custom build flavors the task is named publishApkRelease.

Publishing app bundle

In the application module's build.gradle

apply plugin: 'com.android.application'
apply plugin: 'android-autoplay'

autoplay {
    track "internal"
    artifactType "bundle"
    secretJsonBase64 project.hasProperty('SECRET_JSON') ? project.property('SECRET_JSON') : ''
}

Execute ./gradlew tasks and you will see a new publishing task publishBundle<BuildVariant> in the list. Autoplay adds this task for each build variant of release type. For a project without custom build flavors the task is named publishBundleRelease.

Central build

Now you can call this task from a central build script. Here is an example of how to use it with Gitlab CI.

stages:
  - assemble
  - release

assemble:
  stage: assemble
  only:
    - master
  script:
    - ./gradlew clean bundleRelease -PSTORE_PASS=${STORE_PASS} -PKEY_PASS=${KEY_PASS}
  artifacts:
    paths:
      - app/build/outputs/

release:
  stage: release
  dependencies:
    - assemble
  only:
    - master
  script:
    - ./gradlew publishBundleRelease -PSECRET_JSON=${SECRET_JSON}

You can encode JSON key file into base64 string using following shell command (linux, mac)

base64 -i secret.json -o -

and provide the value to the build script using a protected variable.

Publishing Release Notes

Autoplay takes apk and obfuscation mapping files (or app bundle file, if artifactType "bundle" is set) for uploading from the default build output directories. Release notes are to be stored under src/main/autoplay/release-notes directory in accordance to the structure shown down below.

src
  +- main
       +- java
       +- autoplay
            +- release-notes
                 +- <track>           e.g. internal
                     +- <locale>.txt  e.g. en-US.txt

Properties

Autoplay supports following gradle.properties

Name Default Description
autoplay.connectTimeout 120000ms Connection establishment timeout in milliseconds.
autoplay.readTimeout 120000ms Connection reading timeout in milliseconds.

Happy continuous integration!

License

Copyright 2018 Sergej Shafarenka, www.halfbit.de

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.