Class: Fastlane::Actions::FivIonicAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb

Constant Summary collapse

ANDROID_ARGS_MAP = 
{
  keystore_path: 'keystore',
  keystore_password: 'storePassword',
  key_password: 'password',
  keystore_alias: 'alias',
}
IOS_ARGS_MAP = 
{
  type: 'packageType',
  team_id: 'developmentTeam',
  provisioning_profile: 'provisioningProfile'
}
PWA_ARGS_MAP = 
{
  
}

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



276
277
278
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 276

def self.authors
  ['fivethree']
end

.available_options ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 151

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :platform,
      env_name: "CORDOVA_PLATFORM",
      description: "Platform to build on. Can be android, ios or browser",
      is_string: true,
      default_value: '',
      verify_block: proc do |value|
        UI.user_error!("Platform should be either android or ios") unless ['', 'android', 'ios', 'browser'].include? value
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :release,
      env_name: "CORDOVA_RELEASE",
      description: "Build for release if true, or for debug if false",
      is_string: false,
      default_value: true,
      verify_block: proc do |value|
        UI.user_error!("Release should be boolean") unless [false, true].include? value
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :prod,
      env_name: "IONIC_PROD",
      description: "Build for production",
      is_string: false,
      default_value: false,
      verify_block: proc do |value|
        UI.user_error!("Prod should be boolean") unless [false, true].include? value
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :type,
      env_name: "CORDOVA_IOS_PACKAGE_TYPE",
      description: "This will determine what type of build is generated by Xcode. Valid options are development, enterprise, adhoc, and appstore",
      is_string: true,
      default_value: 'appstore',
      verify_block: proc do |value|
        UI.user_error!("Valid options are development, enterprise, adhoc, and appstore.") unless ['development', 'enterprise', 'adhoc', 'appstore', 'ad-hoc', 'app-store'].include? value
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :team_id,
      env_name: "CORDOVA_IOS_TEAM_ID",
      description: "The development team (Team ID) to use for code signing",
      is_string: true,
      default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id)
    ),
    FastlaneCore::ConfigItem.new(
      key: :provisioning_profile,
      env_name: "CORDOVA_IOS_PROVISIONING_PROFILE",
      description: "GUID of the provisioning profile to be used for signing",
      is_string: true,
      default_value: ''
    ),
    FastlaneCore::ConfigItem.new(
      key: :keystore_path,
      env_name: "CORDOVA_ANDROID_KEYSTORE_PATH",
      description: "Path to the Keystore for Android",
      is_string: true,
      default_value: ''
    ),
    FastlaneCore::ConfigItem.new(
      key: :keystore_password,
      env_name: "CORDOVA_ANDROID_KEYSTORE_PASSWORD",
      description: "Android Keystore password",
      is_string: true,
      default_value: ''
    ),
    FastlaneCore::ConfigItem.new(
      key: :key_password,
      env_name: "CORDOVA_ANDROID_KEY_PASSWORD",
      description: "Android Key password (default is keystore password)",
      is_string: true,
      default_value: ''
    ),
    FastlaneCore::ConfigItem.new(
      key: :keystore_alias,
      env_name: "CORDOVA_ANDROID_KEYSTORE_ALIAS",
      description: "Android Keystore alias",
      is_string: true,
      default_value: ''
    ),
    FastlaneCore::ConfigItem.new(
      key: :cordova_prepare,
      env_name: "CORDOVA_PREPARE",
      description: "Specifies whether to run `ionic cordova prepare` before building",
      default_value: true,
      is_string: false
    ),
    FastlaneCore::ConfigItem.new(
      key: :fresh,
      env_name: "BUILD_FRESH",
      description: "Clean install packages, plugins and platform",
      default_value: false,
      is_string: false
    ),
    FastlaneCore::ConfigItem.new(
      key: :plugins,
      env_name: "REFRESH_PLUGINS",
      description: "also refresh plugins",
      default_value: false,
      is_string: false
    ),
    FastlaneCore::ConfigItem.new(
      key: :package_manager,
      env_name: "PACKAGE_MANAGER",
      description: "What package manager to use to install dependencies: e.g. yarn | npm",
      is_string: true,
      default_value: 'npm',
      verify_block: proc do |value|
        UI.user_error!("Platform should be either android, ios or browser") unless ['', 'yarn', 'npm'].include? value
      end
    ),
  ]
end

.build(params) ⇒ Object

actual building! (run #2)



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 88

def self.build(params)
  args = [params[:release] ? '--release' : '--debug']
  args << '--prod' if params[:prod]
  android_args = self.get_android_args(params) if params[:platform].to_s == 'android'
  ios_args = self.get_ios_args(params) if params[:platform].to_s == 'ios'
  pwa_args = self.get_pwa_args(params) if params[:platform].to_s == 'browser'

  if params[:cordova_prepare]
    # TODO: Remove params not allowed/used for `prepare`
    sh "ionic cordova prepare #{params[:platform]} #{args.join(' ')}"
  end


  if params[:platform].to_s == 'ios'
    sh "ionic cordova compile #{params[:platform]} #{args.join(' ')} -- #{ios_args}" 
  elsif params[:platform].to_s == 'android'
    sh "ionic cordova compile #{params[:platform]} #{args.join(' ')} -- -- #{android_args}" 
  elsif params[:platform].to_s == 'browser'
    sh "ionic cordova compile #{params[:platform]} #{args.join(' ')} -- -- #{pwa_args}" 
  end
end

.category ⇒ Object 



292
293
294
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 292

def self.category
  :building
end

.check_and_add_platform(platform) ⇒ Object

add cordova platform if missing (run #1)



75
76
77
78
79
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 75

def self.check_and_add_platform(platform)
  if platform && !File.directory?("./platforms/#{platform}")
    sh "ionic cordova platform add #{platform}"
  end
end

.description ⇒ Object 



143
144
145
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 143

def self.description
  "Build your Ionic app"
end

.details ⇒ Object 



147
148
149
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 147

def self.details
  "Easily integrate your Ionic build into a Fastlane setup"
end

.example_code ⇒ Object 



284
285
286
287
288
289
290
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 284

def self.example_code
  [
    "ionic(
      platform: 'ios'
    )"
  ]
end

.get_android_args(params) ⇒ Object

map action params to the cli param they will be used for



43
44
45
46
47
48
49
50
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 43

def self.get_android_args(params)
  # TODO document magic in README
  if params[:key_password].empty?
    params[:key_password] = params[:keystore_password]
  end

  return self.get_platform_args(params, ANDROID_ARGS_MAP)
end

.get_app_name ⇒ Object

app_name



82
83
84
85
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 82

def self.get_app_name
  config = REXML::Document.new(File.open('config.xml'))
  return config.elements['widget'].elements['name'].first.value # TODO: Simplify!? (Check logic in cordova)
end

.get_ios_args(params) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 52

def self.get_ios_args(params)
  app_identifier = CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)

  if params[:provisioning_profile].empty?
    # If `match` or `sigh` were used before this, use the certificates returned from there
    params[:provisioning_profile] = ENV['SIGH_UUID'] || ENV["sigh_#{app_identifier}_#{params[:type].sub('-', '')}"]
  end

  if params[:type] == 'adhoc'
    params[:type] = 'ad-hoc'
  end
  if params[:type] == 'appstore'
    params[:type] = 'app-store'
  end

  return self.get_platform_args(params, IOS_ARGS_MAP)
end

.get_platform_args(params, args_map) ⇒ Object

do rewriting and copying of action params



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 29

def self.get_platform_args(params, args_map)
  platform_args = []
  args_map.each do |action_key, cli_param|
    param_value = params[action_key]
    unless param_value.to_s.empty?
      platform_args << "--#{cli_param}=#{Shellwords.escape(param_value)}"
    end
  end

  return platform_args.join(' ')
end

.get_pwa_args(params) ⇒ Object 



70
71
72
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 70

def self.get_pwa_args(params)
  return self.get_platform_args(params, PWA_ARGS_MAP)
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


280
281
282
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 280

def self.is_supported?(platform)
  true
end

.output ⇒ Object 



269
270
271
272
273
274
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 269

def self.output
  [
    ['CORDOVA_ANDROID_RELEASE_BUILD_PATH', 'Path to the signed release APK if it was generated'],
    ['CORDOVA_IOS_RELEASE_BUILD_PATH', 'Path to the signed release IPA if it was generated']
  ]
end

.run(params) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 122

def self.run(params)
  if params[:fresh]
    Fastlane::Actions::FivCleanInstallAction.run(params)
  end
  self.check_and_add_platform(params[:platform])
  self.build(params)
  self.set_build_paths(params[:release])

  if params[:platform].to_s == 'ios'
    return ENV['CORDOVA_IOS_RELEASE_BUILD_PATH'] 
  elsif params[:platform].to_s == 'android'
    return ENV['CORDOVA_ANDROID_RELEASE_BUILD_PATH']
  elsif params[:platform].to_s == 'browser'
    return ENV['CORDOVA_PWA_RELEASE_BUILD_PATH']
  end
end

.set_build_paths(is_release) ⇒ Object

export build paths (run #3)



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/fastlane/plugin/fivethree_ionic/actions/fiv_ionic.rb', line 111

def self.set_build_paths(is_release)
  app_name = self.get_app_name
  build_type = is_release ? 'release' : 'debug'

  ENV['CORDOVA_ANDROID_RELEASE_BUILD_PATH'] = "./platforms/android/build/outputs/apk/android-#{build_type}.apk"
  ENV['CORDOVA_IOS_RELEASE_BUILD_PATH'] = "./platforms/ios/build/device/#{app_name}.ipa"
  ENV['CORDOVA_PWA_RELEASE_BUILD_PATH'] = "./platforms/browser/www"

  # TODO: https://github.com/bamlab/fastlane-plugin-cordova/issues/7
end