Class: Fastlane::Actions::SentryUploadSourcemapAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



200
201
202
 
# File 'lib/fastlane/plugin/sentry/actions/sentry_upload_sourcemap.rb', line 200

def self.authors
  ["wschurman"]
end

.available_options ⇒ Object 



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
 
# File 'lib/fastlane/plugin/sentry/actions/sentry_upload_sourcemap.rb', line 87

def self.available_options
  Helper::SentryConfig.common_api_config_items + [
    FastlaneCore::ConfigItem.new(key: :version,
                                 description: "Release version on Sentry"),
    FastlaneCore::ConfigItem.new(key: :app_identifier,
                                 short_option: "-a",
                                 env_name: "SENTRY_APP_IDENTIFIER",
                                 description: "App Bundle Identifier, prepended to version",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :build,
                                 short_option: "-b",
                                 description: "Release build on Sentry",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :dist,
                                 description: "Distribution in release",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :sourcemap,
                                 description: "Path or an array of paths to the sourcemap(s) to upload",
                                 type: Array,
                                 verify_block: proc do |values|
                                   [*values].each do |value|
                                     UI.user_error! "Could not find sourcemap at path '#{value}'" unless File.exist?(value)
                                   end
                                 end),
    FastlaneCore::ConfigItem.new(key: :rewrite,
                                 description: "Rewrite the sourcemaps before upload",
                                 default_value: false,
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :strip_prefix,
                                 conflicting_options: [:strip_common_prefix],
                                 description: "Chop-off a prefix from uploaded files. Strips the given prefix from all \
                                 sources references inside the upload sourcemaps (paths used within the sourcemap \
                                 content, to map minified code to it's original source). Only sources that start \
                                 with the given prefix will be stripped. This will not modify the uploaded sources \
                                 paths",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :strip_common_prefix,
                                 conflicting_options: [:strip_prefix],
                                 description: "Automatically guess what the common prefix is and chop that one off",
                                 default_value: false,
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :url_prefix,
                                 description: "Sets a URL prefix in front of all files",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :url_suffix,
                                 description: "Sets a URL suffix to append to all filenames",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :note,
                                 description: "Adds an optional note to the uploaded artifact bundle",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :validate,
                                 description: "Enable basic sourcemap validation",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :decompress,
                                 description: "Enable files gzip decompression prior to upload",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :wait,
                                 description: "Wait for the server to fully process uploaded files",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :wait_for,
                                 description: "Wait for the server to fully process uploaded files, but at most \
                                 for the given number of seconds",
                                 type: Integer,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :no_sourcemap_reference,
                                 description: "Disable emitting of automatic sourcemap references. By default the \
                                 tool will store a 'Sourcemap' header with minified files so that sourcemaps \
                                 are located automatically if the tool can detect a link. If this causes issues \
                                 it can be disabled",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :debug_id_reference,
                                 description: "Enable emitting of automatic debug id references. By default Debug ID \
                                 reference has to be present both in the source and the related sourcemap. But in \
                                 cases of binary bundles, the tool can't verify presence of the Debug ID. This flag \
                                 allows use of Debug ID from the linked sourcemap",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :bundle,
                                 description: "Path to the application bundle (indexed, file, or regular)",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :bundle_sourcemap,
                                 description: "Path to the bundle sourcemap",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :ext,
                                 description: "Set the file extensions that are considered for upload. This overrides \
                                 the default extensions. To add an extension, all default extensions must be repeated. \
                                 Specify once per extension. Defaults to: js, cjs, mjs, map, jsbundle, bundle",
                                 type: Array,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :strict,
                                 description: "Fail with a non-zero exit code if the specified source map file cannot be uploaded",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :ignore,
                                 description: "Ignores all files and folders matching the given glob or array of globs",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :ignore_file,
                                 description: "Ignore all files and folders specified in the given ignore file, e.g. .gitignore",
                                 optional: true)
  ]
end

.description ⇒ Object 



76
77
78
 
# File 'lib/fastlane/plugin/sentry/actions/sentry_upload_sourcemap.rb', line 76

def self.description
  "Upload one or more sourcemap(s) to a release of a project on Sentry"
end

.details ⇒ Object 



80
81
82
83
84
85
 
# File 'lib/fastlane/plugin/sentry/actions/sentry_upload_sourcemap.rb', line 80

def self.details
  [
    "This action allows you to upload one or more sourcemap(s) to a release of a project on Sentry.",
    "See https://docs.sentry.io/learn/cli/releases/#upload-sourcemaps for more information."
  ].join(" ")
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


204
205
206
 
# File 'lib/fastlane/plugin/sentry/actions/sentry_upload_sourcemap.rb', line 204

def self.is_supported?(platform)
  true
end

.return_value ⇒ Object 



196
197
198
 
# File 'lib/fastlane/plugin/sentry/actions/sentry_upload_sourcemap.rb', line 196

def self.return_value
  nil
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
64
65
66
67
68
69
70
 
# File 'lib/fastlane/plugin/sentry/actions/sentry_upload_sourcemap.rb', line 4

def self.run(params)
  require 'shellwords'

  Helper::SentryConfig.parse_api_params(params)

  version = params[:version]
  version = "#{params[:app_identifier]}@#{params[:version]}" if params[:app_identifier]
  version = "#{version}+#{params[:build]}" if params[:build]

  sourcemaps = params[:sourcemap]

  command = [
    "sourcemaps",
    "upload",
    "--release",
    version
  ]
  command += sourcemaps

  command.push('--no-rewrite') unless params[:rewrite]
  command.push('--strip-prefix').push(params[:strip_prefix]) if params[:strip_prefix]
  command.push('--strip-common-prefix') if params[:strip_common_prefix]
  command.push('--url-prefix').push(params[:url_prefix]) unless params[:url_prefix].nil?
  command.push('--url-suffix').push(params[:url_suffix]) unless params[:url_suffix].nil?
  command.push('--dist').push(params[:dist]) unless params[:dist].nil?
  command.push('--note').push(params[:note]) unless params[:note].nil?
  command.push('--validate') if params[:validate]
  command.push('--decompress') if params[:decompress]
  command.push('--wait') if params[:wait]
  command.push('--wait-for').push(params[:wait_for]) unless params[:wait_for].nil?
  command.push('--no-sourcemap-reference') if params[:no_sourcemap_reference]
  command.push('--debug-id-reference') if params[:debug_id_reference]
  command.push('--bundle').push(params[:bundle]) unless params[:bundle].nil?
  command.push('--bundle-sourcemap').push(params[:bundle_sourcemap]) unless params[:bundle_sourcemap].nil?
  command.push('--strict') if params[:strict]

  unless params[:ignore].nil?
    # normalize to array
    unless params[:ignore].kind_of?(Enumerable)
      params[:ignore] = [params[:ignore]]
    end
    # no nil or empty strings
    params[:ignore].reject! do |e|
      e.strip.empty?
    rescue StandardError
      true
    end
    params[:ignore].each do |pattern|
      command.push('--ignore').push(pattern)
    end
  end

  command.push('--ignore-file').push(params[:ignore_file]) unless params[:ignore_file].nil?

  unless params[:ext].nil?
    # normalize to array
    unless params[:ext].kind_of?(Enumerable)
      params[:ext] = [params[:ext]]
    end
    params[:ext].each do |extension|
      command.push('--ext').push(extension)
    end
  end

  Helper::SentryHelper.call_sentry_cli(params, command)
  UI.success("Successfully uploaded files to release: #{version}")
end