class Fastlane::Actions::AndroidSdkUpdateAction

Public Class Methods

authors() click to toggle source
# File lib/fastlane/plugin/android_sdk_update/actions/android_sdk_update_action.rb, line 157
def self.authors
  ["Philipp Burgk", "Michael Ruhl"]
end
available_options() click to toggle source
# File lib/fastlane/plugin/android_sdk_update/actions/android_sdk_update_action.rb, line 117
def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :compile_sdk_version,
                                 env_name: "FL_ANDROID_COMPILE_SDK_VERSION",
                                 description: "Compile-SDK Version of the project. Can also defined in 'gradle.properties'",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :build_tools_version,
                                 env_name: "FL_ANDROID_BUILD_TOOLS_VERSION",
                                 description: "Build-Tools Version of the project. Can also defined in 'gradle.properties'",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :additional_packages,
                                 description: "List with additional sdk packages. Examples:\n
                                • extras;google;m2repository
                                • extras;android;m2repository",
                                 is_string: false,
                                 optional: true,
                                 default_value: []),
    FastlaneCore::ConfigItem.new(key: :override_local_properties,
                                 env_name: "FL_ANDROID_SDK_OVERRIDE_LOCAL_PROPERTIES",
                                 description: "Set the sdk-dir in 'local.properties' so Gradle finds the Android home",
                                 is_string: false,
                                 default_value: true),
    FastlaneCore::ConfigItem.new(key: :update_installed_packages,
                                 env_name: "FL_ANDROID_SDK_UPDATE_INSTALLED_PACKAGES",
                                 description: "Update all installed packages to the latest versions",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :linux_sdk_dir,
                                  env_name: "FL_ANDROID_LINUX_SDK_DIR",
                                  description: "Directory for Android SDK on Linux",
                                  optional: true,
                                  default_value: ENV['ANDROID_HOME'] || ENV['ANDROID_SDK'] || ENV['ANDROID_SDK_ROOT'] || "~/.android-sdk"),
    FastlaneCore::ConfigItem.new(key: :linux_sdk_download_url,
                                  env_name: "FL_ANDROID_LINUX_SDK_DOWNLOAD_URL",
                                  description: "Download URL for Android SDK on Linux",
                                  optional: true,
                                  default_value: "https://dl.google.com/android/repository/sdk-tools-linux-4333796.zip")
  ]
end
description() click to toggle source

@!group Documentation

# File lib/fastlane/plugin/android_sdk_update/actions/android_sdk_update_action.rb, line 92
def self.description
  "Install and update required Android-SDK packages"
end
details() click to toggle source
# File lib/fastlane/plugin/android_sdk_update/actions/android_sdk_update_action.rb, line 96
def self.details
  [
    "The initial Android-SDK will be installed with Homebrew/Linuxbrew.",
    "Updates for the specified packages will be automatically installed.",
    "Instructions to configure 'compile_sdk_version' and 'build_tools_version': https://github.com/NovaTecConsulting/fastlane-plugin-android_sdk_update"
  ].join("\n")
end
determine_sdk(params) click to toggle source
# File lib/fastlane/plugin/android_sdk_update/actions/android_sdk_update_action.rb, line 50
def self.determine_sdk(params)
  # on mac
  if FastlaneCore::Helper.mac?
    require 'fastlane/plugin/brew'
    Actions::BrewAction.run(command: "list --cask --versions android-sdk || brew install --cask android-sdk")
    sdk_path = File.realpath("../../..", FastlaneCore::CommandExecutor.which("sdkmanager"))

  # on linux
  elsif FastlaneCore::Helper.linux?
    sdk_path = File.expand_path(params[:linux_sdk_dir])
    if File.exist?("#{sdk_path}/tools/bin/sdkmanager")
      UI.message("Using existing android-sdk at #{sdk_path}")
    else
      UI.message("Downloading android-sdk to #{sdk_path}")
      download_and_extract_sdk(params[:linux_sdk_download_url], sdk_path)
    end

  else
    UI.user_error! 'Your OS is currently not supported.'
  end

  ENV['ANDROID_SDK_ROOT'] = sdk_path
  sdk_path
end
download_and_extract_sdk(download_url, sdk_path) click to toggle source
# File lib/fastlane/plugin/android_sdk_update/actions/android_sdk_update_action.rb, line 75
def self.download_and_extract_sdk(download_url, sdk_path)
  FastlaneCore::CommandExecutor.execute(command: "wget -O /tmp/android-sdk-tools.zip #{download_url}",
                                        print_all: true,
                                        print_command: true)
  FastlaneCore::CommandExecutor.execute(command: "unzip -qo /tmp/android-sdk-tools.zip -d #{sdk_path}",
                                        print_all: true,
                                        print_command: true)
ensure
  FastlaneCore::CommandExecutor.execute(command: "rm -f /tmp/android-sdk-tools.zip",
                                        print_all: true,
                                        print_command: true)
end
example_code() click to toggle source
# File lib/fastlane/plugin/android_sdk_update/actions/android_sdk_update_action.rb, line 104
def self.example_code
  [
    'android_sdk_update(
      additional_packages: ["extras;google;m2repository", "extras;android;m2repository"]
    )',
    'android_sdk_update(
      compile_sdk_version: "25",
      build_tools_version: "25.0.2",
      additional_packages: ["extras;google;m2repository", "extras;android;m2repository"]
    )'
  ]
end
is_supported?(platform) click to toggle source
# File lib/fastlane/plugin/android_sdk_update/actions/android_sdk_update_action.rb, line 161
def self.is_supported?(platform)
  platform == :android
end
run(params) click to toggle source
# File lib/fastlane/plugin/android_sdk_update/actions/android_sdk_update_action.rb, line 4
def self.run(params)
  # Install Android-SDK via brew
  sdk_path = determine_sdk(params)
  sdk_manager = File.expand_path("tools/bin/sdkmanager", sdk_path)

  # Define required packages
  require 'java-properties'
  properties = File.exist?("#{Dir.pwd}/gradle.properties") ? JavaProperties.load("#{Dir.pwd}/gradle.properties") : {}
  tools_version = params[:build_tools_version] || properties[:build_tools_version] || UI.user_error!('No build tools version defined.')
  sdk_version = params[:compile_sdk_version] || properties[:compile_sdk_version] || UI.user_error!('No compile sdk version defined.')

  packages = params[:additional_packages]
  packages << "platforms;android-#{sdk_version}"
  packages << "build-tools;#{tools_version}"
  packages << "tools"
  packages << "platform-tools"

  # Install Packages
  UI.header("Install Android-SDK packages")

  if params[:update_installed_packages]
    UI.message("Updating all installed packages")
    # Ensure all installed packages are updated
    FastlaneCore::CommandExecutor.execute(command: "yes | #{sdk_manager} --update",
                                          print_all: true,
                                          print_command: false)
  end

  UI.message("Installing packages...")
  packages.each { |package| UI.message("• #{package}") }
  FastlaneCore::CommandExecutor.execute(command: "yes | #{sdk_manager} '#{packages.join("' '")}'",
                                        print_all: true,
                                        print_command: false)

  # Accept licenses for all available packages
  UI.important("Accepting licenses on your behalf!")
  FastlaneCore::CommandExecutor.execute(command: "yes | #{sdk_manager} --licenses",
                                         print_all: true,
                                         print_command: false)

  if params[:override_local_properties]
    UI.message("Override local.properties")
    JavaProperties.write({ :"sdk.dir" => sdk_path }, "#{Dir.pwd}/local.properties")
  end
end