fastlane-plugin-sentry 0

data/lib/fastlane/plugin/sentry/actions/sentry_upload_sourcemap.rb

@@ -0,0 +1,209 @@
+module Fastlane
+  module Actions
+    class SentryUploadSourcemapAction < Action
+      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
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Upload one or more sourcemap(s) to a release of a project on Sentry"
+      end
+
+      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
+
+      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
+
+      def self.return_value
+        nil
+      end
+
+      def self.authors
+        ["wschurman"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/sentry/helper/sentry_config.rb

@@ -0,0 +1,100 @@
+module Fastlane
+  module Helper
+    class SentryConfig
+      def self.common_cli_config_items
+        [
+          FastlaneCore::ConfigItem.new(key: :sentry_cli_path,
+                                       env_name: "SENTRY_CLI_PATH",
+                                       description: "Path to your sentry-cli. Defaults to `which sentry-cli`",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error! "'#{value}' is not executable" unless FastlaneCore::Helper.executable?(value)
+                                       end)
+        ]
+      end
+
+      def self.common_api_config_items
+        [
+          FastlaneCore::ConfigItem.new(key: :url,
+                                       env_name: "SENTRY_URL",
+                                       description: "Url for Sentry",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :auth_token,
+                                       env_name: "SENTRY_AUTH_TOKEN",
+                                       description: "Authentication token for Sentry",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :org_slug,
+                                       env_name: "SENTRY_ORG_SLUG",
+                                       description: "Organization slug for Sentry project",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :project_slug,
+                                       env_name: "SENTRY_PROJECT_SLUG",
+                                       description: "Project slug for Sentry",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :log_level,
+                                       env_name: "SENTRY_LOG_LEVEL",
+                                       description: "Configures the log level used by sentry-cli",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error! "Invalid log level '#{value}'" unless ['trace', 'debug', 'info', 'warn', 'error'].include? value.downcase
+                                       end)
+        ] + self.common_cli_config_items
+      end
+
+      def self.parse_api_params(params)
+        require 'shellwords'
+
+        url = params[:url]
+        auth_token = params[:auth_token]
+        org = params[:org_slug]
+        project = params[:project_slug]
+        log_level = params[:log_level]
+
+        has_org = !org.to_s.empty?
+        has_project = !project.to_s.empty?
+        has_auth_token = !auth_token.to_s.empty?
+
+        ENV['SENTRY_URL'] = url unless url.to_s.empty?
+
+        if log_level.to_s.empty?
+          ENV['SENTRY_LOG_LEVEL'] = 'debug' if FastlaneCore::Globals.verbose?
+        else
+          ENV['SENTRY_LOG_LEVEL'] = log_level
+        end
+
+        # Fallback to .sentryclirc if possible when no auth token is provided
+        if !has_auth_token && fallback_sentry_cli_auth(params)
+          UI.important("No auth config provided, will fallback to .sentryclirc")
+        else
+          # Will fail if no authentication token is provided
+          unless has_auth_token
+            UI.user_error!("No authentication token found for SentryAction given, pass using `auth_token: 'token'`")
+          end
+          ENV['SENTRY_AUTH_TOKEN'] = auth_token unless auth_token.to_s.empty?
+        end
+
+        if has_org && has_project
+          ENV['SENTRY_ORG'] = Shellwords.escape(org) unless org.to_s.empty?
+          ENV['SENTRY_PROJECT'] = Shellwords.escape(project) unless project.to_s.empty?
+        elsif !has_org
+          UI.important("Missing 'org_slug' parameter. Provide both 'org_slug' and 'project_slug'. Falling back to .sentryclirc")
+        elsif !has_project
+          UI.important("Missing 'project_slug' parameter. Provide both 'org_slug' and 'project_slug'. Falling back to .sentryclirc")
+        end
+      end
+
+      def self.fallback_sentry_cli_auth(params)
+        sentry_cli_result = JSON.parse(SentryHelper.call_sentry_cli(
+                                         params,
+                                         [
+                                           "info",
+                                           "--config-status-json"
+                                         ]
+                                       ))
+        return (sentry_cli_result["auth"]["successful"] &&
+          !sentry_cli_result["auth"]["type"].nil?)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/sentry/helper/sentry_helper.rb

@@ -0,0 +1,87 @@
+require 'os'
+
+module Fastlane
+  module Helper
+    class SentryHelper
+      def self.find_and_check_sentry_cli_path!(params)
+        bundled_sentry_cli_path = self.bundled_sentry_cli_path
+        bundled_sentry_cli_version = Gem::Version.new(`#{bundled_sentry_cli_path} --version`.scan(/(?:\d+\.?){3}/).first)
+
+        sentry_cli_path = params[:sentry_cli_path] || bundled_sentry_cli_path
+
+        sentry_cli_version = Gem::Version.new(`#{sentry_cli_path} --version`.scan(/(?:\d+\.?){3}/).first)
+
+        if sentry_cli_version < bundled_sentry_cli_version
+          UI.user_error!("Your sentry-cli is outdated, please upgrade to at least version #{bundled_sentry_cli_version} and start your lane again!")
+        end
+
+        UI.success("Using sentry-cli #{sentry_cli_version}")
+        sentry_cli_path
+      end
+
+      def self.call_sentry_cli(params, sub_command)
+        sentry_path = self.find_and_check_sentry_cli_path!(params)
+        command = [sentry_path] + sub_command
+        UI.message "Starting sentry-cli..."
+        require 'open3'
+
+        final_command = command.map { |arg| Shellwords.escape(arg) }.join(" ")
+
+        if FastlaneCore::Globals.verbose?
+          UI.command(final_command)
+        end
+
+        env = { 'SENTRY_PIPELINE' => "sentry-fastlane-plugin/#{Fastlane::Sentry::VERSION}" }
+        Open3.popen3(env, final_command) do |stdin, stdout, stderr, status_thread|
+          out_reader = Thread.new do
+            output = []
+
+            stdout.each_line do |line|
+              l = line.strip!
+              UI.message(l)
+              output << l
+            end
+
+            output.join
+          end
+
+          err_reader = Thread.new do
+            stderr.each_line do |line|
+              UI.message(line.strip!)
+            end
+          end
+
+          unless status_thread.value.success?
+            UI.user_error!('Error while calling Sentry CLI')
+          end
+
+          err_reader.join
+          out_reader.value
+        end
+      end
+
+      def self.bundled_sentry_cli_path
+        if OS.mac?
+          self.bin_folder('sentry-cli-Darwin-universal')
+        elsif OS.windows?
+          if OS.bits == 64
+            self.bin_folder('sentry-cli-Windows-x86_64.exe')
+          else
+            self.bin_folder('sentry-cli-Windows-i686.exe')
+          end
+        else
+          if OS.bits == 64
+            self.bin_folder('sentry-cli-Linux-x86_64')
+          else
+            self.bin_folder('sentry-cli-Linux-i686')
+          end
+        end
+      end
+
+      # Get path for files in bin folder. Paths are resolved relative to this file, for which there are also unit tests.
+      def self.bin_folder(filename)
+        File.expand_path("../../../../../bin/#{filename}", File.dirname(__FILE__))
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/sentry/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Sentry
+    VERSION = ""
+  end
+end

data/lib/fastlane/plugin/sentry.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/sentry/version'
+
+module Fastlane
+  module Sentry
+    # Return all .rb files inside the "actions" and "helper"  directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Sentry.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-sentry
+version: !ruby/object:Gem::Version
+  version: '0'
+platform: ruby
+authors:
+- Sentry
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: hello@sentry.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/sentry-cli-Darwin-universal
+- bin/sentry-cli-Linux-i686
+- bin/sentry-cli-Linux-x86_64
+- bin/sentry-cli-Windows-i686.exe
+- bin/sentry-cli-Windows-x86_64.exe
+- lib/fastlane/plugin/sentry.rb
+- lib/fastlane/plugin/sentry/actions/sentry_check_cli_installed.rb
+- lib/fastlane/plugin/sentry/actions/sentry_create_deploy.rb
+- lib/fastlane/plugin/sentry/actions/sentry_create_release.rb
+- lib/fastlane/plugin/sentry/actions/sentry_debug_files_upload.rb
+- lib/fastlane/plugin/sentry/actions/sentry_finalize_release.rb
+- lib/fastlane/plugin/sentry/actions/sentry_set_commits.rb
+- lib/fastlane/plugin/sentry/actions/sentry_upload_build.rb
+- lib/fastlane/plugin/sentry/actions/sentry_upload_proguard.rb
+- lib/fastlane/plugin/sentry/actions/sentry_upload_sourcemap.rb
+- lib/fastlane/plugin/sentry/helper/sentry_config.rb
+- lib/fastlane/plugin/sentry/helper/sentry_helper.rb
+- lib/fastlane/plugin/sentry/version.rb
+homepage: https://github.com/getsentry/sentry-fastlane-plugin
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Upload symbols to Sentry
+test_files: []