Class: Fastlane::Actions::FlutterBootstrapAction

Inherits:
Action
  • Object
show all
Extended by:
FlutterActionBase
Defined in:
lib/fastlane/plugin/flutter/actions/flutter_bootstrap_action.rb

Constant Summary collapse

FLUTTER_REMOTE_REPOSITORY = 
'https://github.com/flutter/flutter.git'

Class Method Summary collapse

Methods included from FlutterActionBase

authors, is_supported?

Class Method Details

.android_sdk_root! ⇒ Object 



78
79
80
81
82
83
84
85
86
 
# File 'lib/fastlane/plugin/flutter/actions/flutter_bootstrap_action.rb', line 78

def self.android_sdk_root!
  (ENV['ANDROID_HOME'] || ENV['ANDROID_SDK_ROOT']).tap do |path|
    unless path
      UI.build_failure!('Android SDK directory environment variables ' \
        'are not set. See ' \
        'https://developer.android.com/studio/command-line/variables')
    end
  end
end

.available_options ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/fastlane/plugin/flutter/actions/flutter_bootstrap_action.rb', line 92

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :flutter_channel,
      env_name: 'FL_FLUTTER_CHANNEL',
      description: 'Flutter SDK channel (keep existing if unset)',
      optional: true,
      type: String
    ),
    FastlaneCore::ConfigItem.new(
      key: :flutter_auto_upgrade,
      env_name: 'FL_FLUTTER_AUTO_UPGRADE',
      description: 'Automatically upgrade Flutter when already installed',
      default_value: true,
      optional: true,
      is_string: false # official replacement for "type: Boolean"
    ),
    FastlaneCore::ConfigItem.new(
      key: :android_licenses,
      description: 'Map of file names to hash values of accepted ' \
      'Android SDK linceses, which may be found in ' \
      '$ANDROID_SDK_ROOT/licenses/ on developer workstations. Gradle ' \
      'will refuse to install SDK unless licenses are accepted',
      optional: true,
      type: Hash
    )
  ]
end

.description ⇒ Object 



88
89
90
 
# File 'lib/fastlane/plugin/flutter/actions/flutter_bootstrap_action.rb', line 88

def self.description
  'Flutter SDK installation, upgrade and application bootstrap'
end

.need_upgrade_to_channel?(flutter_sdk_root, flutter_channel) ⇒ Boolean

Returns:

  • (Boolean) 


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/fastlane/plugin/flutter/actions/flutter_bootstrap_action.rb', line 51

def self.need_upgrade_to_channel?(flutter_sdk_root, flutter_channel)
  # No channel specified -- always upgrade.
  return true unless flutter_channel

  remote_hash = Helper::FlutterHelper.git(
    'ls-remote', FLUTTER_REMOTE_REPOSITORY, flutter_channel
  ) do |status, output, _errors_thread|
    output.split[0].strip if status.success?
  end
  local_hash = Helper::FlutterHelper.git(
    '-C', flutter_sdk_root, 'rev-parse', 'HEAD'
  ) do |status, output, _errors_thread|
    output.strip if status.success?
  end

  if !local_hash.nil? && local_hash == remote_hash
    UI.message('Local and remote Flutter repository hashes match ' \
               "(#{local_hash}), no upgrade necessary. Keeping Git " \
               'index untouched!')
    false
  else
    UI.message("Local hash (#{local_hash}) of Flutter repository " \
               "differs from remote (#{remote_hash}), upgrading")
    true
  end
end

.run(params) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/fastlane/plugin/flutter/actions/flutter_bootstrap_action.rb', line 15

def self.run(params)
  if params[:android_licenses]
    Helper::FlutterBootstrapHelper.accept_licenses(
      File.join(android_sdk_root!, 'licenses'),
      params[:android_licenses]
    )
  end

  # Upgrade or install Flutter SDK.
  flutter_sdk_root = Helper::FlutterHelper.flutter_sdk_root
  flutter_channel = params[:flutter_channel]
  if Helper::FlutterHelper.flutter_installed?
    if flutter_channel
      UI.message("Making sure Flutter is on channel #{flutter_channel}")
      Helper::FlutterHelper.flutter('channel', flutter_channel) {}
    end
    if params[:flutter_auto_upgrade] &&
       need_upgrade_to_channel?(flutter_sdk_root, flutter_channel)
      UI.message("Upgrading Flutter SDK in #{flutter_sdk_root}...")
      Helper::FlutterHelper.flutter('upgrade') {}
    end
  else
    Helper::FlutterHelper.git(
      'clone', # no --depth limit to keep Flutter tag-based versioning.
      "--branch=#{flutter_channel || 'stable'}",
      '--quiet',
      '--',
      FLUTTER_REMOTE_REPOSITORY,
      flutter_sdk_root
    )
  end

  # Return installation path of Flutter SDK.
  flutter_sdk_root
end