Class: Fastlane::Actions::UploadSymbolsToSentryAction

Inherits:
Fastlane::Action show all
Defined in:
lib/fastlane/actions/upload_symbols_to_sentry.rb

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, output, sh, step_text

Class Method Details

.authors ⇒ Object 



110
111
112
 
# File 'lib/fastlane/actions/upload_symbols_to_sentry.rb', line 110

def self.authors
  ["joshdholtz"]
end

.available_options ⇒ Object 



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
 
# File 'lib/fastlane/actions/upload_symbols_to_sentry.rb', line 59

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :api_host,
                                 env_name: "SENTRY_HOST",
                                 description: "API host url for Sentry",
                                 is_string: true,
                                 default_value: "https://app.getsentry.com/api/0",
                                 optional: true
                                ),
    FastlaneCore::ConfigItem.new(key: :api_key,
                                 env_name: "SENTRY_API_KEY",
                                 description: "API Key for Sentry",
                                 verify_block: proc do |value|
                                   UI.user_error!("No API token for SentryAction given, pass using `api_key: 'key'`") unless value and !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :org_slug,
                                 env_name: "SENTRY_ORG_SLUG",
                                 description: "Organization slug for Sentry project",
                                 verify_block: proc do |value|
                                   UI.user_error!("No organization slug for SentryAction given, pass using `org_slug: 'org'`") unless value and !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :project_slug,
                                 env_name: "SENTRY_PROJECT_SLUG",
                                 description: "Prgoject slug for Sentry",
                                 verify_block: proc do |value|
                                   UI.user_error!("No project slug for SentryAction given, pass using `project_slug: 'project'`") unless value and !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :dsym_path,
                                 env_name: "SENTRY_DSYM_PATH",
                                 description: "Path to your symbols file. For iOS and Mac provide path to app.dSYM.zip",
                                 default_value: Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH],
                                 optional: true,
                                 verify_block: proc do |value|
                                   # validation is done in the action
                                 end),
    FastlaneCore::ConfigItem.new(key: :dsym_paths,
                                 env_name: "SENTRY_DSYM_PATHS",
                                 description: "Path to an array of your symbols file. For iOS and Mac provide path to app.dSYM.zip",
                                 default_value: Actions.lane_context[SharedValues::DSYM_PATHS],
                                 is_string: false,
                                 optional: true,
                                 verify_block: proc do |value|
                                   # validation is done in the action
                                 end)
  ]
end

.description ⇒ Object 



47
48
49
 
# File 'lib/fastlane/actions/upload_symbols_to_sentry.rb', line 47

def self.description
  "Upload dSYM symbolication files to Sentry"
end

.details ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/fastlane/actions/upload_symbols_to_sentry.rb', line 51

def self.details
  [
    "This action allows you to upload symbolication files to Sentry.",
    "It's extra useful if you use it to download the latest dSYM files from Apple when you",
    "use Bitcode"
  ].join(" ")
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/fastlane/actions/upload_symbols_to_sentry.rb', line 114

def self.is_supported?(platform)
  platform == :ios
end

.return_value ⇒ Object 



106
107
108
 
# File 'lib/fastlane/actions/upload_symbols_to_sentry.rb', line 106

def self.return_value
  "The uploaded dSYM path(s)"
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
 
# File 'lib/fastlane/actions/upload_symbols_to_sentry.rb', line 4

def self.run(params)
  require 'rest-client'

  # Params - API
  host = params[:api_host]
  api_key = params[:api_key]
  org = params[:org_slug]
  project = params[:project_slug]

  # Params - dSYM
  dsym_path = params[:dsym_path]
  dsym_paths = params[:dsym_paths] || []

  # Url to post dSYMs to
  url = "#{host}/projects/#{org}/#{project}/files/dsyms/"
  resource = RestClient::Resource.new( url, api_key, '' )

  UI.message "Will upload dSYM(s) to #{url}"

  # Upload dsym(s)
  dsym_paths += [dsym_path]
  uploaded_paths = dsym_paths.compact.map do |dsym|
    upload_dsym(resource, dsym)
  end

  # Return uplaoded dSYM paths
  uploaded_paths
end

.upload_dsym(resource, dsym) ⇒ Object 



33
34
35
36
37
38
39
40
41
 
# File 'lib/fastlane/actions/upload_symbols_to_sentry.rb', line 33

def self.upload_dsym(resource, dsym)
  UI.message "Uploading... #{dsym}"
  resource.post(file: File.new(dsym, 'rb')) unless Helper.test?
  UI.success 'dSYM successfully uploaded to Sentry!'

  dsym
rescue
  UI.user_error! 'Error while trying to upload dSYM to Sentry'
end