Class: Fastlane::Actions::AltoolAction

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

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



41
42
43
 
# File 'lib/fastlane/plugin/altool/actions/altool_action.rb', line 41

def self.authors
  ["Shashikant Jagtap"]
end

.available_options ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/fastlane/plugin/altool/actions/altool_action.rb', line 54

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :altool_app_type,
                              env_name: "ALTOOL_APP_TYPE",
                              description: "Type or platform of application e.g osx, ios, appletvos ",
                              default_value: "ios",
                              is_string: true,
                              optional: true),

    FastlaneCore::ConfigItem.new(key: :altool_ipa_path,
                              env_name: "ALTOOL_IPA_PATH",
                              description: "Path to IPA file ",
                              is_string: true,
                              default_value: Dir["*.ipa"].sort_by { |x| File.mtime(x) }.last,
                              optional: false,
                              verify_block: proc do |value|
                                value = File.expand_path(value)
                                UI.user_error!("Could not find ipa file at path '#{value}'") unless File.exist?(value)
                                UI.user_error!("'#{value}' doesn't seem to be an ipa file") unless value.end_with?(".ipa")
                              end),

    FastlaneCore::ConfigItem.new(key: :altool_username,
                              env_name: "ALTOOL_USERNAME",
                              description: "Your Apple ID for iTunes Connects. This usually FASTLANE_USER environmental variable",
                              is_string: true,
                              default_value: ENV["FASTLANE_USER"],
                              optional: false,
                              ),

    FastlaneCore::ConfigItem.new(key: :altool_password,
                              env_name: "ALTOOL_PASSWORD",
                              description: "Your Apple ID Password for iTunes Connects. This usually FASTLANE_PASSWORD environmental variable",
                              is_string: true,
                              default_value: ENV["FASTLANE_PASSWORD"],
                              optional: false,
                              ),

    FastlaneCore::ConfigItem.new(key: :altool_output_format,
                              env_name: "ALTOOL_OUTPUT_FORMAT",
                              description: "Output formal xml or normal ",
                              default_value: "normal",
                              is_string: true,
                              optional: true)

  ]
end

.description ⇒ Object 



37
38
39
 
# File 'lib/fastlane/plugin/altool/actions/altool_action.rb', line 37

def self.description
  "Upload IPA to iTunes Connect using altool"
end

.details ⇒ Object 



49
50
51
52
 
# File 'lib/fastlane/plugin/altool/actions/altool_action.rb', line 49

def self.details
  # Optional:
  "This plugin can be used for uploading ipa files to iTunes Connect using altool rahter than using ITMSTransporter.. Currently Fastlane deliver upload an ipa file using iTMSTransporter tool. There is another slick command line too called altool that can be used to upload ipa files as well"
end

.example_code ⇒ Object 



101
102
103
104
105
106
107
108
109
110
 
# File 'lib/fastlane/plugin/altool/actions/altool_action.rb', line 101

def self.example_code
  ['   altool(
      altool_username: ENV["FASTLANE_USER"],
      altool_password: ENV["FASTLANE_PASSWORD"],
      altool_app_type: "ios",
      altool_ipa_path: "./build/Your-ipa.ipa",
      altool_output_format: "xml",
  )
 ']
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


112
113
114
115
116
117
118
 
# File 'lib/fastlane/plugin/altool/actions/altool_action.rb', line 112

def self.is_supported?(platform)
  # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
  # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
  #
  # [:ios, :mac, :android].include?(platform)
  true
end

.return_value ⇒ Object 



45
46
47
 
# File 'lib/fastlane/plugin/altool/actions/altool_action.rb', line 45

def self.return_value
  # If your method provides a return value, you can describe here what it does
end

.run(params) ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/fastlane/plugin/altool/actions/altool_action.rb', line 7

def self.run(params)
  altool_path = "/Applications/Xcode.app/Contents/Applications/Application\ Loader.app/Contents/Frameworks/ITunesSoftwareService.framework/Support/altool"
  unless File.exist? altool_path
    UI.user_error!("altool binary not found. Please check your Xcode installtion")
  end

  altool_app_type = params[:altool_app_type]
  altool_ipa_path = params[:altool_ipa_path]
  altool_username = params[:altool_username]
  altool_password = params[:altool_password]
  altool_output_format = params[:altool_output_format]

  command = [
    "/Applications/Xcode.app/Contents/Applications/Application\ Loader.app/Contents/Frameworks/ITunesSoftwareService.framework/Support/altool",
    '--upload-app',
    '-t',
    altool_app_type,
    '-f',
    altool_ipa_path,
    '-u',
    altool_username,
    '-p',
    altool_password,
    '--output-format',
    altool_output_format
  ]

  Actions.sh(command.join(' '))
end