fastlane-plugin-sentry 1.9.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fcaac063173141e154a7713fe39aaea1f541d6656faca25b59e97e74ac8628a
-  data.tar.gz: be174a0c3dd6b3c1df22a87c0b67b90aebf0e4684a1aff65dc183e2c2d9d1356
+  metadata.gz: c53121ea7f7c00d665e77435c5fef8f378efe2a718fd8268b0cda6833592eb10
+  data.tar.gz: 4fac12d2ad679a0ec2ea2311192fd18d9eff66a0be91987cdfa1bfdce0136e16
 SHA512:
-  metadata.gz: 1c4962ae6e42b13c30f9633ff2026358cac06c73c9a00a2b88cd025dc7872771f360667d40ed4915efde2df0cdc8a87fb69781f87ea9d9ff47721cc79a76f685
-  data.tar.gz: d4fd92588967cdce3bc6847752afc63cf496edeb2d5b978f2252fe99ab58439c64779b7c7016a9e4dc4db0864abeb11da2a0553f9d21a0764e6c7f9124e772c2
+  metadata.gz: 8a1ce6458533a6244d154588f78c1376d862bb425e37d08351a89203210588d1d6a5d4345d3f01e43d900a9185416fb3e3cd96f2aafbcb47eb5996f19bd12278
+  data.tar.gz: 3224bd013b9221dd2feca2c740d686bfa4abe5633cceeda742ad4acf02897d71f402bf74704cf5d4f33472dac081d8dd693a4825640ed8c490e64cb2a3cab018

data/README.md

@@ -22,7 +22,7 @@ fastlane add_plugin sentry
 
 A subset of actions provided by the CLI: https://docs.sentry.io/learn/cli/
 
-#### Authentication & Configuration
+### Authentication & Configuration
 
 `auth_token` is the preferred way to authentication method with Sentry. This can be obtained on https://sentry.io/api/.
 `api_key` still works but will eventually become deprecated. This can be obtained through the settings of your project.
@@ -30,7 +30,40 @@ Also note that as of version `1.2.0` you no longer have to provide the required
 
 The following environment variables may be used in place of parameters: `SENTRY_API_KEY`, `SENTRY_AUTH_TOKEN`, `SENTRY_ORG_SLUG`, and `SENTRY_PROJECT_SLUG`.
 
-#### Uploading Symbolication Files
+### Uploading Debug Information Files
+
+```ruby
+sentry_upload_dif(
+  api_key: '...', # Do not use if using auth_token
+  auth_token: '...', # Do not use if using api_key
+  org_slug: '...',
+  project_slug: '...',
+  path: '/path/to/files', # Optional. We'll default to '.' when no value is provided.
+)
+```
+
+The `SENTRY_DSYM_PATH` environment variable may be used in place of the `dsym_path` parameter.
+
+Further options:
+
+- __type__: Optional. Only consider debug information files of the given type. By default, all types are considered. Valid options: 'dsym', 'elf', 'breakpad', 'pdb', 'pe', 'sourcebundle', 'bcsymbolmap'.
+- __no_unwind__: Optional. Do not scan for stack unwinding information. Specify this flag for builds with disabled FPO, or when stackwalking occurs on the device. This usually excludes executables and dynamic libraries. They might still be uploaded, if they contain additional processable information (see other flags)".
+- __no_debug__: Optional. Do not scan for debugging information. This will usually exclude debug companion files. They might still be uploaded, if they contain additional processable information (see other flags)".
+- __no_sources__: Optional. "Do not scan for source information. This will usually exclude source bundle files. They might still be uploaded, if they contain additional processable information (see other flags)".
+- __ids__: Optional. Search for specific debug identifiers.
+- __require_all__: Optional. Errors if not all identifiers specified with --id could be found.
+- __symbol_maps__: Optional. Optional path to BCSymbolMap files which are used to resolve hidden symbols in dSYM files downloaded from iTunes Connect. This requires the dsymutil tool to be available.
+- __derived_data__: Optional. Search for debug symbols in Xcode's derived data.
+- __no_zips__: Do not search in ZIP files.
+- __info_plist__: Optional. Optional path to the Info.plist. We will try to find this automatically if run from Xcode.  Providing this information will associate the debug symbols with a specific ITC application and build in Sentry.  Note that if you provide the plist explicitly it must already be processed.
+- __no_reprocessing__: Optional. Do not trigger reprocessing after uploading.                           
+- __force_foreground__: Optional. Wait for the process to finish. By default, the upload process will detach and continue in the background when triggered from Xcode.  When an error happens, a dialog is shown.  If this parameter is passed Xcode will wait for the process to finish before the build finishes and output will be shown in the Xcode build output.
+- __include_sources__: Optional. Include sources from the local file system and upload them as source bundles.
+- __wait__: Wait for the server to fully process uploaded files. Errors can only be displayed if --wait is specified, but this will significantly slow down the upload process.
+- __upload_symbol_maps__: Optional. Upload any BCSymbolMap files found to allow Sentry to resolve hidden symbols, e.g. when it downloads dSYMs directly from App Store Connect or when you upload dSYMs without first resolving the hidden symbols using --symbol-maps.
+
+
+Or the soon to be deprecated way:
 
 ```ruby
 sentry_upload_dsym(
@@ -44,9 +77,7 @@ sentry_upload_dsym(
 )
 ```
 
-The `SENTRY_DSYM_PATH` environment variable may be used in place of the `dsym_path` parameter.
-
-#### Creating & Finalizing Releases
+### Creating & Finalizing Releases
 
 ```ruby
 sentry_create_release(
@@ -60,7 +91,7 @@ sentry_create_release(
 )
 ```
 
-#### Uploading Files & Sourcemaps
+### Uploading Files & Sourcemaps
 
 Useful for uploading build artifacts and JS sourcemaps for react-native apps built using fastlane.
 
@@ -93,7 +124,7 @@ sentry_upload_sourcemap(
 )
 ```
 
-#### Uploading Proguard Mapping File
+### Uploading Proguard Mapping File
 
 ```ruby
 sentry_upload_proguard(
@@ -106,19 +137,7 @@ sentry_upload_proguard(
 )
 ```
 
-#### Upload Debugging Information Files
-
-```ruby
-sentry_upload_dif(
-  api_key: '...', # Do not use if using auth_token
-  auth_token: '...', # Do not use if using api_key
-  org_slug: '...',
-  project_slug: '...',
-  path: '/path/to/files'
-)
-```
-
-#### Associating commits
+### Associating commits
 
 Useful for telling Sentry which commits are associated with a release.
 
@@ -133,7 +152,7 @@ sentry_set_commits(
 )
 ```
 
-#### Create deploy
+### Create deploy
 
 Creates a new release deployment for a project on Sentry.
 
@@ -155,6 +174,14 @@ sentry_create_deploy(
 )
 ```
 
+### Checking the sentry-cli is installed
+
+Useful for checking that the sentry-cli is installed and meets the minimum version requirements before starting to build your app in your lane.
+
+```ruby
+sentry_check_cli_installed()
+```
+
 ## Issues and Feedback
 
 For any other issues and feedback about this plugin, please submit it to this repository.

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

@@ -0,0 +1,37 @@
+module Fastlane
+  module Actions
+    class SentryCheckCliInstalledAction < Action
+      def self.run(params)
+        Helper::SentryHelper.check_sentry_cli!
+        UI.success("Successfully checked that sentry-cli is installed")
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Checks that sentry-cli with the correct version is installed"
+      end
+
+      def self.details
+        [
+          "This action checks that the senty-cli is installed and meets the mimum verson requirements.",
+          "You can use it at the start of your lane to ensure that sentry-cli is correctly installed."
+        ].join(" ")
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.authors
+        ["matt-oakes"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -17,7 +17,7 @@ module Fastlane
           "new",
           version
         ]
-        command.push("--finalize") if params[:finalize].nil?
+        command.push("--finalize") if params[:finalize] == true
 
         Helper::SentryHelper.call_sentry_cli(command)
         UI.success("Successfully created release: #{version}")

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

@@ -8,6 +8,7 @@ module Fastlane
         Helper::SentryConfig.parse_api_params(params)
 
         path = params[:path]
+        path = '.' if path.nil?
 
         command = [
           "sentry-cli",
@@ -15,20 +16,20 @@ module Fastlane
           path
         ]
         command.push('--type').push(params[:type]) unless params[:type].nil?
-        command.push('--no_unwind') unless params[:no_unwind].nil?
-        command.push('--no_debug') unless params[:no_debug].nil?
-        command.push('--no_sources') unless params[:no_sources].nil?
+        command.push('--no-unwind') unless params[:no_unwind].nil?
+        command.push('--no-debug') unless params[:no_debug].nil?
+        command.push('--no-sources') unless params[:no_sources].nil?
         command.push('--ids').push(params[:ids]) unless params[:ids].nil?
-        command.push('--require_all') unless params[:require_all].nil?
-        command.push('--symbol_maps').push(params[:symbol_maps]) unless params[:symbol_maps].nil?
-        command.push('--derived_data') unless params[:derived_data].nil?
-        command.push('--no_zips') unless params[:no_zips].nil?
-        command.push('--info_plist').push(params[:info_plist]) unless params[:info_plist].nil?
-        command.push('--no_reprocessing') unless params[:no_reprocessing].nil?
-        command.push('--force_foreground') unless params[:force_foreground].nil?
-        command.push('--include_sources') unless params[:include_sources].nil?
+        command.push('--require-all') unless params[:require_all].nil?
+        command.push('--symbol-maps').push(params[:symbol_maps]) unless params[:symbol_maps].nil?
+        command.push('--derived-data') unless params[:derived_data].nil?
+        command.push('--no-zips') unless params[:no_zips].nil?
+        command.push('--info-plist').push(params[:info_plist]) unless params[:info_plist].nil?
+        command.push('--no-reprocessing') unless params[:no_reprocessing].nil?
+        command.push('--force-foreground') unless params[:force_foreground].nil?
+        command.push('--include-sources') unless params[:include_sources].nil?
         command.push('--wait') unless params[:wait].nil?
-        command.push('--upload_symbol_maps') unless params[:upload_symbol_maps].nil?
+        command.push('--upload-symbol-maps') unless params[:upload_symbol_maps].nil?
 
         Helper::SentryHelper.call_sentry_cli(command)
         UI.success("Successfully ran upload-dif")
@@ -52,7 +53,8 @@ module Fastlane
       def self.available_options
         Helper::SentryConfig.common_api_config_items + [
           FastlaneCore::ConfigItem.new(key: :path,
-                                       description: "A path to search recursively for symbol files"),
+                                       description: "A path to search recursively for symbol files",
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :type,
                                        short_option: "-t",
                                        description: "Only consider debug information files of the given \

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

@@ -36,7 +36,7 @@ module Fastlane
       def self.details
         [
           "This action allows you to upload the proguard mapping file to Sentry.",
-          "See https://docs.sentry.io/cli/dif/proguard for more information."
+          "See https://docs.sentry.io/product/cli/dif/#proguard-mapping-upload for more information."
         ].join(" ")
       end
 

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

@@ -1,6 +1,6 @@
 module Fastlane
   module Sentry
-    VERSION = "1.9.0"
-    CLI_VERSION = "1.63.1"
+    VERSION = "1.11.1"
+    CLI_VERSION = "1.72.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-sentry
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.11.1
 platform: ruby
 authors:
 - Sentry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -89,6 +89,7 @@ files:
 - LICENSE
 - README.md
 - 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_finalize_release.rb