step.yml

title: Android Build
summary: Builds your Android project with gradle.
description: Builds your Android project with gradle.
website: https://github.com/bitrise-steplib/bitrise-step-android-build
source_code_url: https://github.com/bitrise-steplib/bitrise-step-android-build
support_url: https://github.com/bitrise-steplib/bitrise-step-android-build/issues
host_os_tags:
  - osx-10.10
  - ubuntu-16.04

project_type_tags:
  - android
  - react-native

type_tags:
  - build

is_requires_admin_user: true
is_always_run: false
is_skippable: false

toolkit:
  go:
    package_name: github.com/bitrise-steplib/bitrise-step-android-build

inputs:
  - project_location: $BITRISE_SOURCE_DIR
    opts:
      title: Project Location
      summary: "The root directory of your android project, e.g.: where your root build gradle file exist (also gradlew, settings.gradle, etc...)"
      description: "The root directory of your android project, e.g.: where your root build gradle file exist (also gradlew, settings.gradle, etc...)"
      is_required: true
  - module: ""
    opts:
      title: Module
      summary: |
        Set the module that you want to build. To see your available modules please open your project in Android Studio and go in [Project Structure] and see the list on the left.
      description: |
        Set the module that you want to build. To see your available modules please open your project in Android Studio and go in [Project Structure] and see the list on the left.
      is_required: false
  - variant: ""
    opts:
      title: Variant
      summary: |
        Set the variant that you want to build. To see your available variants please open your project in Android Studio and go in [Project Structure] -> variants section.
      description: |
        Set the variant that you want to build. To see your available variants please open your project in Android Studio and go in [Project Structure] -> variants section.
      is_required: false
  - apk_path_pattern: "*/build/outputs/apk/*.apk"
    opts:
      category: Options
      title: APK location pattern
      summary: Will find the APK files with the given pattern.
      description: Will find the APK files with the given pattern.
      is_required: true
  - cache_level: "only_deps"
    opts:
      category: Options
      title: Set the level of cache
      description: |-
        `all` - will cache build cache and dependencies
        `only_deps` - will cache dependencies only
        `none` - will not cache anything
      is_required: true
      value_options:
      - "all"
      - "only_deps"
      - "none"
  - arguments:
    opts:
      category: Options
      title: Additional Gradle Arguments 
      summary: Extra arguments passed to the gradle task
      description: Extra arguments passed to the gradle task
      is_required: false
outputs:
  - BITRISE_APK_PATH:
    opts:
      title: "Path of the generated APK"
      summary: "Path of the generated (and copied) APK - after filtering."
      description: |-
        This output will include the path of the generated APK,
        after filtering based on the filter inputs.
        If the build generates more than one APK which fulfills the
        filter inputs this output will contain the last one's path.
  - BITRISE_APK_PATH_LIST:
    opts:
      title: "List of the generated APK paths"
      summary: "List of the generated (and copied) APK paths - after filtering."
      description: |-
        This output will include the paths of the generated APKs,
        after filtering based on the filter inputs.
        The paths are separated with `|` character, eg: `app-armeabi-v7a-debug.apk|app-mips-debug.apk|app-x86-debug.apk`
  - BITRISE_MAPPING_PATH:
    opts:
      title: "Path of the generated mapping.txt"
      summary: "Path of the generated (and copied) mapping.txt."
      description: |-
        This output will include the path of the generated mapping.txt.
        If more than one mapping.txt exist in project this output will contain the last one's path.