Class: Fastlane::Actions::S3Action
- Inherits:
-
Fastlane::Action
- Object
- Fastlane::Action
- Fastlane::Actions::S3Action
- Defined in:
- lib/fastlane/actions/s3.rb
Class Method Summary collapse
- .author ⇒ Object
- .available_options ⇒ Object
- .description ⇒ Object
-
.expand_path_with_substitutions_from_ipa_plist(ipa, path) ⇒ Object
NOT a fan of this as this was taken straight from Shenzhen github.com/nomad/shenzhen/blob/986792db5d4d16a80c865a2748ee96ba63644821/lib/shenzhen/plugins/s3.rb#L32.
- .get_ipa_info(ipa_file) ⇒ Object
- .is_supported?(platform) ⇒ Boolean
- .output ⇒ Object
- .params_to_build_args(params) ⇒ Object
- .run(config) ⇒ Object
- .upload_plist_and_html_to_s3(s3_access_key, s3_secret_access_key, s3_bucket, plist_file_name, plist_render, html_file_name, html_render, version_file_name, version_render) ⇒ Object
Methods inherited from Fastlane::Action
action_name, authors, details, sh, step_text
Class Method Details
.author ⇒ Object
341 342 343 |
# File 'lib/fastlane/actions/s3.rb', line 341 def self. "joshdholtz" end |
.available_options ⇒ Object
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/fastlane/actions/s3.rb', line 258 def self. [ FastlaneCore::ConfigItem.new(key: :ipa, env_name: "", description: ".ipa file for the build ", optional: true, default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]), FastlaneCore::ConfigItem.new(key: :dsym, env_name: "", description: "zipped .dsym package for the build ", optional: true, default_value: Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH]), FastlaneCore::ConfigItem.new(key: :upload_metadata, env_name: "", description: "Upload relevant metadata for this build", optional: true, default_value: true), FastlaneCore::ConfigItem.new(key: :plist_template_path, env_name: "", description: "plist template path", optional: true), FastlaneCore::ConfigItem.new(key: :html_template_path, env_name: "", description: "html erb template path", optional: true), FastlaneCore::ConfigItem.new(key: :html_file_name, env_name: "", description: "uploaded html filename", optional: true), FastlaneCore::ConfigItem.new(key: :version_template_path, env_name: "", description: "version erb template path", optional: true), FastlaneCore::ConfigItem.new(key: :version_file_name, env_name: "", description: "uploaded version filename", optional: true), FastlaneCore::ConfigItem.new(key: :access_key, env_name: "S3_ACCESS_KEY", description: "AWS Access Key ID ", optional: true, default_value: ENV['AWS_ACCESS_KEY_ID']), FastlaneCore::ConfigItem.new(key: :secret_access_key, env_name: "S3_SECRET_ACCESS_KEY", description: "AWS Secret Access Key ", optional: true, default_value: ENV['AWS_SECRET_ACCESS_KEY']), FastlaneCore::ConfigItem.new(key: :bucket, env_name: "S3_BUCKET", description: "AWS bucket name", optional: true, default_value: ENV['AWS_BUCKET_NAME']), FastlaneCore::ConfigItem.new(key: :region, env_name: "S3_REGION", description: "AWS region (for bucket creation) ", optional: true, default_value: ENV['AWS_REGION']), FastlaneCore::ConfigItem.new(key: :path, env_name: "S3_PATH", description: "S3 'path'. Values from Info.plist will be substituded for keys wrapped in {} ", optional: true, default_value: 'v{CFBundleShortVersionString}_b{CFBundleVersion}/'), FastlaneCore::ConfigItem.new(key: :source, env_name: "S3_SOURCE", description: "Optional source directory e.g. ./build ", optional: true), FastlaneCore::ConfigItem.new(key: :acl, env_name: "S3_ACL", description: "Uploaded object permissions e.g public_read (default), private, public_read_write, authenticated_read ", optional: true,), ] end |
.description ⇒ Object
254 255 256 |
# File 'lib/fastlane/actions/s3.rb', line 254 def self.description "Generates a plist file and uploads all to AWS S3" end |
.expand_path_with_substitutions_from_ipa_plist(ipa, path) ⇒ Object
NOT a fan of this as this was taken straight from Shenzhen github.com/nomad/shenzhen/blob/986792db5d4d16a80c865a2748ee96ba63644821/lib/shenzhen/plugins/s3.rb#L32
Need to find a way to not use this copied method
AGAIN, I am not happy about this right now. Using this for prototype reasons.
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/fastlane/actions/s3.rb', line 216 def self.(ipa, path) substitutions = path.scan(/\{CFBundle[^}]+\}/) return path if substitutions.empty? Dir.mktmpdir do |dir| system "unzip -q #{ipa} -d #{dir} 2> /dev/null" plist = Dir["#{dir}/**/*.app/Info.plist"].last substitutions.uniq.each do |substitution| key = substitution[1...-1] value = Shenzhen::PlistBuddy.print(plist, key) path.gsub!(Regexp.new(substitution), value) if value end end return path end |
.get_ipa_info(ipa_file) ⇒ Object
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'lib/fastlane/actions/s3.rb', line 236 def self.get_ipa_info(ipa_file) bundle_id, bundle_version, title, full_version = nil Dir.mktmpdir do |dir| system "unzip -q #{ipa_file} -d #{dir} 2> /dev/null" plist = Dir["#{dir}/**/*.app/Info.plist"].last bundle_id = Shenzhen::PlistBuddy.print(plist, 'CFBundleIdentifier') bundle_version = Shenzhen::PlistBuddy.print(plist, 'CFBundleShortVersionString') title = Shenzhen::PlistBuddy.print(plist, 'CFBundleName') # This is the string: {CFBundleShortVersionString}.{CFBundleVersion} full_version = bundle_version + '.' + Shenzhen::PlistBuddy.print(plist, 'CFBundleVersion') end return bundle_id, bundle_version, title, full_version end |
.is_supported?(platform) ⇒ Boolean
345 346 347 |
# File 'lib/fastlane/actions/s3.rb', line 345 def self.is_supported?(platform) platform == :ios end |
.output ⇒ Object
331 332 333 334 335 336 337 338 339 |
# File 'lib/fastlane/actions/s3.rb', line 331 def self.output [ ['S3_IPA_OUTPUT_PATH', 'Direct HTTP link to the uploaded ipa file'], ['S3_DSYM_OUTPUT_PATH', 'Direct HTTP link to the uploaded dsym file'], ['S3_PLIST_OUTPUT_PATH', 'Direct HTTP link to the uploaded plist file'], ['S3_HTML_OUTPUT_PATH', 'Direct HTTP link to the uploaded HTML file'], ['S3_VERSION_OUTPUT_PATH', 'Direct HTTP link to the uploaded Version file'] ] end |
.params_to_build_args(params) ⇒ Object
168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/fastlane/actions/s3.rb', line 168 def self.params_to_build_args(params) # Remove nil value params unless :clean or :archive params = params.delete_if { |k, v| (k != :clean && k != :archive ) && v.nil? } # Maps nice developer param names to Shenzhen's `ipa build` arguments params.collect do |k,v| v ||= '' if args = S3_ARGS_MAP[k] value = (v.to_s.length > 0 ? "\"#{v}\"" : "") "#{S3_ARGS_MAP[k]} #{value}".strip end end.compact end |
.run(config) ⇒ Object
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 |
# File 'lib/fastlane/actions/s3.rb', line 29 def self.run(config) # Calling fetch on config so that default values will be used params = {} params[:ipa] = config[:ipa] params[:dsym] = config[:dsym] params[:access_key] = config[:access_key] params[:secret_access_key] = config[:secret_access_key] params[:bucket] = config[:bucket] params[:region] = config[:region] params[:acl] = config[:acl] params[:source] = config[:source] params[:path] = config[:path] params[:upload_metadata] = config[:upload_metadata] params[:plist_template_path] = config[:plist_template_path] params[:html_template_path] = config[:html_template_path] params[:html_file_name] = config[:html_file_name] params[:version_template_path] = config[:version_template_path] params[:version_file_name] = config[:version_file_name] # Maps nice developer build parameters to Shenzhen args build_args = params_to_build_args(params) # Pulling parameters for other uses s3_subdomain = params[:region] ? "s3-#{params[:region]}" : "s3" s3_access_key = params[:access_key] s3_secret_access_key = params[:secret_access_key] s3_bucket = params[:bucket] ipa_file = params[:ipa] dsym_file = params[:dsym] s3_path = params[:path] raise "No S3 access key given, pass using `access_key: 'key'`".red unless s3_access_key.to_s.length > 0 raise "No S3 secret access key given, pass using `secret_access_key: 'secret key'`".red unless s3_secret_access_key.to_s.length > 0 raise "No S3 bucket given, pass using `bucket: 'bucket'`".red unless s3_bucket.to_s.length > 0 raise "No IPA file path given, pass using `ipa: 'ipa path'`".red unless ipa_file.to_s.length > 0 plist_template_path = params[:plist_template_path] html_template_path = params[:html_template_path] html_file_name = params[:html_file_name] version_template_path = params[:version_template_path] version_file_name = params[:version_file_name] if Helper.is_test? return build_args end # Joins args into space delimited string build_args = build_args.join(' ') command = "krausefx-ipa distribute:s3 #{build_args}" Helper.log.debug command Actions.sh command # Gets URL for IPA file url_part = ( ipa_file, s3_path ) ipa_file_name = File.basename(ipa_file) ipa_url = "https://#{s3_subdomain}.amazonaws.com/#{s3_bucket}/#{url_part}#{ipa_file_name}" dsym_url = "https://#{s3_subdomain}.amazonaws.com/#{s3_bucket}/#{url_part}#{dsym_file}" if dsym_file # Setting action and environment variables Actions.lane_context[SharedValues::S3_IPA_OUTPUT_PATH] = ipa_url ENV[SharedValues::S3_IPA_OUTPUT_PATH.to_s] = ipa_url if dsym_file Actions.lane_context[SharedValues::S3_DSYM_OUTPUT_PATH] = dsym_url ENV[SharedValues::S3_DSYM_OUTPUT_PATH.to_s] = dsym_url end if params[:upload_metadata] == false return true end ##################################### # # html and plist building # ##################################### # Gets info used for the plist bundle_id, bundle_version, title, full_version = get_ipa_info(ipa_file) # Creating plist and html names plist_file_name = "#{url_part}#{title}.plist" plist_url = "https://#{s3_subdomain}.amazonaws.com/#{s3_bucket}/#{plist_file_name}" html_file_name ||= "index.html" html_url = "https://#{s3_subdomain}.amazonaws.com/#{s3_bucket}/#{html_file_name}" version_file_name ||= "version.json" version_url = "https://#{s3_subdomain}.amazonaws.com/#{s3_bucket}/#{version_file_name}" #grabs module eth = Fastlane::ErbTemplateHelper # Creates plist from template plist_render = eth.render(eth.load("s3_plist_template"),{ url: ipa_url, bundle_id: bundle_id, bundle_version: bundle_version, title: title }) # Creates html from template html_render = eth.render(eth.load("s3_html_template"),{ url: plist_url, bundle_id: bundle_id, bundle_version: bundle_version, title: title }) # Creates version from template version_render = eth.render(eth.load("s3_version_template"),{ url: plist_url, full_version: full_version }) ##################################### # # html and plist uploading # ##################################### upload_plist_and_html_to_s3( s3_access_key, s3_secret_access_key, s3_bucket, plist_file_name, plist_render, html_file_name, html_render, version_file_name, version_render ) return true end |
.upload_plist_and_html_to_s3(s3_access_key, s3_secret_access_key, s3_bucket, plist_file_name, plist_render, html_file_name, html_render, version_file_name, version_render) ⇒ Object
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/fastlane/actions/s3.rb', line 182 def self.upload_plist_and_html_to_s3(s3_access_key, s3_secret_access_key, s3_bucket, plist_file_name, plist_render, html_file_name, html_render, version_file_name, version_render) require 'aws-sdk' s3_client = AWS::S3.new( access_key_id: s3_access_key, secret_access_key: s3_secret_access_key ) bucket = s3_client.buckets[s3_bucket] plist_obj = bucket.objects.create(plist_file_name, plist_render.to_s, acl: :public_read) html_obj = bucket.objects.create(html_file_name, html_render.to_s, acl: :public_read) version_obj = bucket.objects.create(version_file_name, version_render.to_s, acl: :public_read) # Setting actionand environment variables Actions.lane_context[SharedValues::S3_PLIST_OUTPUT_PATH] = plist_obj.public_url.to_s ENV[SharedValues::S3_PLIST_OUTPUT_PATH.to_s] = plist_obj.public_url.to_s Actions.lane_context[SharedValues::S3_HTML_OUTPUT_PATH] = html_obj.public_url.to_s ENV[SharedValues::S3_HTML_OUTPUT_PATH.to_s] = html_obj.public_url.to_s Actions.lane_context[SharedValues::S3_VERSION_OUTPUT_PATH] = version_obj.public_url.to_s ENV[SharedValues::S3_VERSION_OUTPUT_PATH.to_s] = version_obj.public_url.to_s Helper.log.info "Successfully uploaded ipa file to '#{html_obj.public_url.to_s}'".green end |