Class: Deliver::Options

Inherits:
Object
  • Object
show all
Defined in:
lib/deliver/options.rb

Class Method Summary collapse

Class Method Details

.available_optionsObject



6
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
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
# File 'lib/deliver/options.rb', line 6

def self.available_options
  user = CredentialsManager::AppfileConfig.try_fetch_value(:itunes_connect_id)
  user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)

  [
    FastlaneCore::ConfigItem.new(key: :username,
                                 short_option: "-u",
                                 env_name: "DELIVER_USERNAME",
                                 description: "Your Apple ID Username",
                                 default_value: user),
    FastlaneCore::ConfigItem.new(key: :app_identifier,
                                 short_option: "-a",
                                 env_name: "DELIVER_APP_IDENTIFIER",
                                 description: "The bundle identifier of your app",
                                 optional: true,
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)),
    FastlaneCore::ConfigItem.new(key: :app,
                                 short_option: "-p",
                                 env_name: "DELIVER_APP_ID",
                                 description: "The app ID of the app you want to use/modify",
                                 is_string: false), # don't add any verification here, as it's used to store a spaceship ref
    FastlaneCore::ConfigItem.new(key: :ipa,
                                 short_option: "-i",
                                 optional: true,
                                 env_name: "DELIVER_IPA_PATH",
                                 description: "Path to your ipa file",
                                 default_value: Dir["*.ipa"].first,
                                 verify_block: proc do |value|
                                   raise "Could not find ipa file at path '#{value}'".red unless File.exist?(value)
                                   raise "'#{value}' doesn't seem to be an ipa file".red unless value.end_with?(".ipa")
                                 end,
                                 conflicting_options: [:pkg],
                                 conflict_block: proc do |value|
                                   raise "You can't use 'ipa' and '#{value.key}' options in one run.".red
                                 end),
    FastlaneCore::ConfigItem.new(key: :pkg,
                                 short_option: "-c",
                                 optional: true,
                                 env_name: "DELIVER_PKG_PATH",
                                 description: "Path to your pkg file",
                                 default_value: Dir["*.pkg"].first,
                                 verify_block: proc do |value|
                                   raise "Could not find pkg file at path '#{value}'".red unless File.exist?(value)
                                   raise "'#{value}' doesn't seem to be a pkg file".red unless value.end_with?(".pkg")
                                 end,
                                 conflicting_options: [:ipa],
                                 conflict_block: proc do |value|
                                   raise "You can't use 'pkg' and '#{value.key}' options in one run.".red
                                 end),
    FastlaneCore::ConfigItem.new(key: :metadata_path,
                                 short_option: '-m',
                                 description: "Path to the folder containing the metadata files",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :screenshots_path,
                                 short_option: '-w',
                                 description: "Path to the folder containing the screenshots",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :skip_binary_upload,
                                 description: "Skip uploading an ipa or pkg to iTunes Connect",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :skip_screenshots,
                                 description: "Don't upload the screenhsots",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :app_version,
                                 short_option: '-z',
                                 description: "The version that should be edited or created",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :skip_metadata,
                                 description: "Don't upload the metadata (e.g. title, description), this will still upload screenshots",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :force,
                                 short_option: "-f",
                                 description: "Skip the HTML file verification",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :submit_for_review,
                                 description: "Submit the new version for Review after uploading everything",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :automatic_release,
                                 description: "Should the app be automatically released once it's approved?",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :price_tier,
                                 short_option: "-r",
                                 description: "The price tier of this application",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :app_rating_config_path,
                                 short_option: "-g",
                                 description: "Path to the app rating's config",
                                 is_string: true,
                                 optional: true,
                                 verify_block: proc do |value|
                                   raise "Could not find config file at path '#{value}'".red unless File.exist?(value)
                                   raise "'#{value}' doesn't seem to be a JSON file".red unless value.end_with?(".json")
                                 end),
    FastlaneCore::ConfigItem.new(key: :submission_information,
                                 short_option: "-b",
                                 description: "Extra information for the submission (e.g. third party content)",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :team_id,
                                 short_option: "-k",
                                 env_name: "DELIVER_TEAM_ID",
                                 description: "The ID of your team if you're in multiple teams",
                                 optional: true,
                                 is_string: false, # as we also allow integers, which we convert to strings anyway
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id),
                                 verify_block: proc do |value|
                                   ENV["FASTLANE_ITC_TEAM_ID"] = value.to_s
                                 end),
    FastlaneCore::ConfigItem.new(key: :team_name,
                                 short_option: "-e",
                                 env_name: "DELIVER_TEAM_NAME",
                                 description: "The name of your team if you're in multiple teams",
                                 optional: true,
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name),
                                 verify_block: proc do |value|
                                   ENV["FASTLANE_ITC_TEAM_NAME"] = value
                                 end),

    # App Metadata
    # Non Localised
    FastlaneCore::ConfigItem.new(key: :app_icon,
                                 description: "Metadata: The path to the app icon",
                                 optional: true,
                                 short_option: "-l",
                                 verify_block: proc do |value|
                                   raise "Could not find png file at path '#{value}'".red unless File.exist?(value)
                                   raise "'#{value}' doesn't seem to be a png file".red unless value.end_with?(".png")
                                 end),
    FastlaneCore::ConfigItem.new(key: :apple_watch_app_icon,
                                 description: "Metadata: The path to the Apple Watch app icon",
                                 optional: true,
                                 short_option: "-q",
                                 verify_block: proc do |value|
                                   raise "Could not find png file at path '#{value}'".red unless File.exist?(value)
                                   raise "'#{value}' doesn't seem to be a png file".red unless value.end_with?(".png")
                                 end),
    FastlaneCore::ConfigItem.new(key: :copyright,
                                 description: "Metadata: The copyright notice",
                                 optional: true,
                                 is_string: true),
    FastlaneCore::ConfigItem.new(key: :primary_category,
                                 description: "Metadata: The english name of the primary category(e.g. `Business`, `Books`)",
                                 optional: true,
                                 is_string: true),
    FastlaneCore::ConfigItem.new(key: :secondary_category,
                                 description: "Metadata: The english name of the secondary category(e.g. `Business`, `Books`)",
                                 optional: true,
                                 is_string: true),
    FastlaneCore::ConfigItem.new(key: :primary_first_sub_category,
                                 description: "Metadata: The english name of the primary first sub category(e.g. `Educational`, `Puzzle`)",
                                 optional: true,
                                 is_string: true),
    FastlaneCore::ConfigItem.new(key: :primary_second_sub_category,
                                 description: "Metadata: The english name of the primary second sub category(e.g. `Educational`, `Puzzle`)",
                                 optional: true,
                                 is_string: true),
    FastlaneCore::ConfigItem.new(key: :secondary_first_sub_category,
                                 description: "Metadata: The english name of the secondary first sub category(e.g. `Educational`, `Puzzle`)",
                                 optional: true,
                                 is_string: true),
    FastlaneCore::ConfigItem.new(key: :secondary_second_sub_category,
                                 description: "Metadata: The english name of the secondary second sub category(e.g. `Educational`, `Puzzle`)",
                                 optional: true,
                                 is_string: true),
    FastlaneCore::ConfigItem.new(key: :app_review_information,
                                 description: "Metadata: A hash containing the review information",
                                 optional: true,
                                 is_string: false),
    # Localised
    FastlaneCore::ConfigItem.new(key: :description,
                                 description: "Metadata: The localised app description",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :name,
                                 description: "Metadata: The localised app name",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :keywords,
                                 description: "Metadata: An array of localised keywords",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :release_notes,
                                 description: "Metadata: Localised release notes for this version",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :privacy_url,
                                 description: "Metadata: Localised privacy url",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :support_url,
                                 description: "Metadata: Localised support url",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :marketing_url,
                                 description: "Metadata: Localised marketing url",
                                 optional: true,
                                 is_string: false)
  ]
end