Class: Fastlane::Actions::CrashlyticsAction
- Inherits:
-
Fastlane::Action
- Object
- Fastlane::Action
- Fastlane::Actions::CrashlyticsAction
- Defined in:
- fastlane/lib/fastlane/actions/crashlytics.rb
Constant Summary
Constants inherited from Fastlane::Action
Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES
Class Method Summary collapse
- .author ⇒ Object
- .available_options ⇒ Object
- .category ⇒ Object
- .deprecated_notes ⇒ Object
- .description ⇒ Object
- .details ⇒ Object
- .example_code ⇒ Object
- .is_supported?(platform) ⇒ Boolean
- .run(params) ⇒ Object
Methods inherited from Fastlane::Action
action_name, authors, lane_context, method_missing, other_action, output, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text
Class Method Details
.author ⇒ Object
162 163 164 |
# File 'fastlane/lib/fastlane/actions/crashlytics.rb', line 162 def self. ["KrauseFx", "pedrogimenez"] end |
.available_options ⇒ Object
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 |
# File 'fastlane/lib/fastlane/actions/crashlytics.rb', line 69 def self. platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME] if platform == :ios || platform.nil? ipa_path_default = Dir["*.ipa"].sort_by { |x| File.mtime(x) }.last end if platform == :android apk_path_default = Dir["*.apk"].last || Dir[File.join("app", "build", "outputs", "apk", "app-release.apk")].last end [ # iOS Specific FastlaneCore::ConfigItem.new(key: :ipa_path, env_name: "CRASHLYTICS_IPA_PATH", description: "Path to your IPA file. Optional if you use the _gym_ or _xcodebuild_ action", default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] || ipa_path_default, default_value_dynamic: true, optional: true, verify_block: proc do |value| UI.user_error!("Couldn't find ipa file at path '#{value}'") unless File.exist?(value) end), # Android Specific FastlaneCore::ConfigItem.new(key: :apk_path, env_name: "CRASHLYTICS_APK_PATH", description: "Path to your APK file", default_value: Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] || apk_path_default, default_value_dynamic: true, optional: true, verify_block: proc do |value| UI.user_error!("Couldn't find apk file at path '#{value}'") unless File.exist?(value) end), # General FastlaneCore::ConfigItem.new(key: :crashlytics_path, env_name: "CRASHLYTICS_FRAMEWORK_PATH", description: "Path to the submit binary in the Crashlytics bundle (iOS) or `crashlytics-devtools.jar` file (Android)", optional: true, verify_block: proc do |value| UI.user_error!("Couldn't find crashlytics at path '#{File.(value)}'`") unless File.exist?(File.(value)) end), FastlaneCore::ConfigItem.new(key: :api_token, env_name: "CRASHLYTICS_API_TOKEN", description: "Crashlytics API Key", sensitive: true, verify_block: proc do |value| UI.user_error!("No API token for Crashlytics given, pass using `api_token: 'token'`") unless value && !value.empty? end), FastlaneCore::ConfigItem.new(key: :build_secret, env_name: "CRASHLYTICS_BUILD_SECRET", description: "Crashlytics Build Secret", sensitive: true, verify_block: proc do |value| UI.user_error!("No build secret for Crashlytics given, pass using `build_secret: 'secret'`") unless value && !value.empty? end), FastlaneCore::ConfigItem.new(key: :notes_path, env_name: "CRASHLYTICS_NOTES_PATH", description: "Path to the release notes", optional: true, verify_block: proc do |value| UI.user_error!("Path '#{value}' not found") unless File.exist?(value) end), FastlaneCore::ConfigItem.new(key: :notes, env_name: "CRASHLYTICS_NOTES", description: "The release notes as string - uses :notes_path under the hood", optional: true), FastlaneCore::ConfigItem.new(key: :groups, env_name: "CRASHLYTICS_GROUPS", description: "The groups used for distribution, separated by commas", type: Array, optional: true), FastlaneCore::ConfigItem.new(key: :emails, env_name: "CRASHLYTICS_EMAILS", description: "Pass email addresses of testers, separated by commas", type: Array, optional: true), FastlaneCore::ConfigItem.new(key: :notifications, env_name: "CRASHLYTICS_NOTIFICATIONS", description: "Crashlytics notification option (true/false)", default_value: true, type: Boolean), FastlaneCore::ConfigItem.new(key: :debug, env_name: "CRASHLYTICS_DEBUG", description: "Crashlytics debug option (true/false)", default_value: false, type: Boolean) ] end |
.category ⇒ Object
194 195 196 |
# File 'fastlane/lib/fastlane/actions/crashlytics.rb', line 194 def self.category :deprecated end |
.deprecated_notes ⇒ Object
198 199 200 201 202 203 204 |
# File 'fastlane/lib/fastlane/actions/crashlytics.rb', line 198 def self.deprecated_notes [ "Crashlytics Beta has been deprecated and replaced with Firebase App Distribution.", "Beta will continue working until May 4, 2020.", "Check out the [Firebase App Distribution docs](https://github.com/fastlane/fastlane-plugin-firebase_app_distribution) to get started." ].join("\n") end |
.description ⇒ Object
65 66 67 |
# File 'fastlane/lib/fastlane/actions/crashlytics.rb', line 65 def self.description "Refer to [Firebase App Distribution](https://appdistro.page.link/fastlane-repo)" end |
.details ⇒ Object
166 167 168 169 170 171 172 |
# File 'fastlane/lib/fastlane/actions/crashlytics.rb', line 166 def self.details [ "Additionally, you can specify `notes`, `emails`, `groups` and `notifications`.", "Distributing to Groups: When using the `groups` parameter, it's important to use the group **alias** names for each group you'd like to distribute to. A group's alias can be found in the web UI. If you're viewing the Beta page, you can open the groups dialog by clicking the 'Manage Groups' button.", "This action uses the `submit` binary provided by the Crashlytics framework. If the binary is not found in its usual path, you'll need to specify the path manually by using the `crashlytics_path` option." ].join("\n") end |
.example_code ⇒ Object
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'fastlane/lib/fastlane/actions/crashlytics.rb', line 174 def self.example_code [ 'crashlytics', '# If you installed Crashlytics via CocoaPods crashlytics( crashlytics_path: "./Pods/Crashlytics/submit", # path to your Crashlytics submit binary. api_token: "...", build_secret: "...", ipa_path: "./app.ipa" )', '# If you installed Crashlytics via Carthage for iOS platform crashlytics( crashlytics_path: "./Carthage/Build/iOS/Crashlytics.framework/submit", # path to your Crashlytics submit binary. api_token: "...", build_secret: "...", ipa_path: "./app.ipa" )' ] end |
.is_supported?(platform) ⇒ Boolean
158 159 160 |
# File 'fastlane/lib/fastlane/actions/crashlytics.rb', line 158 def self.is_supported?(platform) [:ios, :mac, :android].include?(platform) end |
.run(params) ⇒ Object
4 5 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 |
# File 'fastlane/lib/fastlane/actions/crashlytics.rb', line 4 def self.run(params) params.values # to validate all inputs before looking for the ipa/apk tempfiles = [] # We need to store notes in a file, because the crashlytics CLI (iOS) says so if params[:notes] UI.error("Overwriting :notes_path, because you specified :notes") if params[:notes_path] changelog = Helper::CrashlyticsHelper.write_to_tempfile(params[:notes], 'changelog') tempfiles << changelog params[:notes_path] = changelog.path elsif Actions.lane_context[SharedValues::FL_CHANGELOG] && !params[:notes_path] UI.("Sending FL_CHANGELOG as release notes to Beta by Crashlytics") changelog = Helper::CrashlyticsHelper.write_to_tempfile( Actions.lane_context[SharedValues::FL_CHANGELOG], 'changelog' ) tempfiles << changelog params[:notes_path] = changelog.path end if params[:ipa_path] command = Helper::CrashlyticsHelper.generate_ios_command(params) elsif params[:apk_path] android_manifest = Helper::CrashlyticsHelper.generate_android_manifest_tempfile tempfiles << android_manifest command = Helper::CrashlyticsHelper.generate_android_command(params, android_manifest.path) else UI.user_error!("You have to either pass an ipa or an apk file to the Crashlytics action") end UI.success('Uploading the build to Crashlytics Beta. Time for some ☕️.') sanitizer = proc do || .gsub(params[:api_token], '[[API_TOKEN]]') .gsub(params[:build_secret], '[[BUILD_SECRET]]') end UI.verbose(sanitizer.call(command.join(' '))) if FastlaneCore::Globals.verbose? error_callback = proc do |error| clean_error = sanitizer.call(error) UI.user_error!(clean_error) end result = Actions.sh_control_output( command.join(" "), print_command: false, print_command_output: false, error_callback: error_callback ) tempfiles.each(&:unlink) return command if Helper.test? UI.verbose(sanitizer.call(result)) if FastlaneCore::Globals.verbose? UI.success('Build successfully uploaded to Crashlytics Beta 🌷') UI.success('Visit https://fabric.io/_/beta to add release notes and notify testers.') end |