feat: Improve path parameter default behavior in sentry_debug_files_upload (#377)

The path parameter now intelligently defaults to DSYM_OUTPUT_PATH from
fastlane's lane context when available (automatically set by actions like
build_app or ipa), which narrows the search scope and improves performance.
If not available, it falls back to '.' (current directory).

- Update sentry_debug_files_upload to use DSYM_OUTPUT_PATH as default
- Add comprehensive tests for DSYM_OUTPUT_PATH behavior
- Update README.md documentation
- Update CHANGELOG.md with improvement note

This addresses issue #290 by providing a smarter default that narrows
the search path when running in typical fastlane workflows.

Author: philprime

CHANGELOG.md

@@ -8,6 +8,7 @@ Due to sentry-cli 3.0.0 upgrade, the following breaking changes have been made (
 
 - **`sentry_upload_file` action has been removed**: The `releases files` commands were removed in sentry-cli 3.0.0. Users should migrate to `sentry_upload_sourcemap` for source maps or other specialized upload actions.
 - **`android_manifest_path` parameter in `sentry_upload_proguard` has been removed**: The `--android-manifest` argument was removed in sentry-cli 3.0.0 and is no longer needed. Any Fastfiles still using this parameter will need to remove it.
+- **`path` parameter default behavior changed in `sentry_debug_files_upload`**: The `path` parameter now defaults to `DSYM_OUTPUT_PATH` from fastlane's lane context if available (set by actions like `build_app` or `ipa`), otherwise falls back to `'.'` (current directory). This changes the default behavior when `DSYM_OUTPUT_PATH` is set, which may affect users who were relying on the previous behavior of always searching from the current directory. Users can explicitly specify `path: '.'` to maintain the previous behavior. This addresses issue [#377](https://github.com/getsentry/sentry-fastlane-plugin/issues/377).
 - **`api_key` parameter has been removed**: The `api_key` parameter has been removed in favor of `auth_token`. All actions now require `auth_token` for authentication. Users should update their Fastfiles to use `auth_token` instead of `api_key`. ([#376](https://github.com/getsentry/sentry-fastlane-plugin/pull/376))
 - **`force_foreground` parameter has been removed**: This parameter was deprecated as a no-op since v1.26.0 and has now been removed from `sentry_debug_files_upload`. Users should remove this parameter from their Fastfiles. ([#376](https://github.com/getsentry/sentry-fastlane-plugin/pull/376))
 - **`sentry_upload_dsym` action has been removed**: This action has been deprecated in favor of `sentry_debug_files_upload`. Users should migrate to `sentry_debug_files_upload` with the appropriate `path` parameter. ([#375](https://github.com/getsentry/sentry-fastlane-plugin/pull/375))

README.md

@@ -62,7 +62,7 @@ sentry_debug_files_upload(
   auth_token: '...',
   org_slug: '...',
   project_slug: '...',
-  path: '/path/to/files', # Optional. Defaults to '.' when no value is provided. Path(s) can be a string, a comma-separated string, or an array of strings.
+  path: '/path/to/files', # Optional. Defaults to DSYM_OUTPUT_PATH from fastlane context if available, otherwise '.' (current directory). Path(s) can be a string, a comma-separated string, or an array of strings.
 )
 ```
 

lib/fastlane/plugin/sentry/actions/sentry_debug_files_upload.rb

@@ -7,7 +7,15 @@ def self.run(params)
         Helper::SentryConfig.parse_api_params(params)
 
         paths = params[:path]
-        paths = ['.'] if paths.nil?
+        # Use DSYM_OUTPUT_PATH from fastlane context if available, otherwise default to current directory
+        if paths.nil?
+          dsym_path = Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH]
+          if dsym_path && !dsym_path.to_s.empty?
+            paths = [dsym_path]
+          else
+            paths = ['.']
+          end
+        end
 
         command = [
           "debug-files",
@@ -52,7 +60,7 @@ def self.details
       def self.available_options
         Helper::SentryConfig.common_api_config_items + [
           FastlaneCore::ConfigItem.new(key: :path,
-                                       description: "Path or an array of paths to search recursively for symbol files",
+                                       description: "Path or an array of paths to search recursively for symbol files. Defaults to DSYM_OUTPUT_PATH from fastlane context if available, otherwise '.' (current directory)",
                                        type: Array,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :type,

spec/sentry_debug_files_upload_spec.rb

@@ -39,7 +39,77 @@
         expect(Fastlane::Helper::SentryHelper).to receive(:call_sentry_cli).with(anything, ["debug-files", "upload", "."]).and_return(true)
 
         Fastlane::FastFile.new.parse("lane :test do
-            sentry_debug_files_upload()
+            sentry_debug_files_upload(
+              auth_token: 'fixture-auth-token'
+            )
+        end").runner.execute(:test)
+      end
+
+      it "uses DSYM_OUTPUT_PATH from lane context when path is not provided" do
+        require 'fastlane'
+        mock_dsym_path = './assets/SwiftExample.app.dSYM.zip'
+
+        # Set the shared value on the correct module BEFORE parsing the lane
+        Fastlane::Actions.lane_context[Fastlane::Actions::SharedValues::DSYM_OUTPUT_PATH] = mock_dsym_path
+
+        expect(Fastlane::Helper::SentryConfig).to receive(:parse_api_params).and_return(true)
+        expect(Fastlane::Helper::SentryHelper).to receive(:call_sentry_cli).with(anything, ["debug-files", "upload", mock_dsym_path]).and_return(true)
+
+        Fastlane::FastFile.new.parse("lane :test do
+            sentry_debug_files_upload(
+              auth_token: 'fixture-auth-token'
+            )
+        end").runner.execute(:test)
+      end
+
+      it "falls back to '.' when DSYM_OUTPUT_PATH is empty string" do
+        require 'fastlane'
+
+        # Set the shared value to empty string
+        Fastlane::Actions.lane_context[Fastlane::Actions::SharedValues::DSYM_OUTPUT_PATH] = ''
+
+        expect(Fastlane::Helper::SentryConfig).to receive(:parse_api_params).and_return(true)
+        expect(Fastlane::Helper::SentryHelper).to receive(:call_sentry_cli).with(anything, ["debug-files", "upload", "."]).and_return(true)
+
+        Fastlane::FastFile.new.parse("lane :test do
+            sentry_debug_files_upload(
+              auth_token: 'fixture-auth-token'
+            )
+        end").runner.execute(:test)
+      end
+
+      it "falls back to '.' when DSYM_OUTPUT_PATH is nil" do
+        require 'fastlane'
+
+        # Set the shared value to nil explicitly
+        Fastlane::Actions.lane_context[Fastlane::Actions::SharedValues::DSYM_OUTPUT_PATH] = nil
+
+        expect(Fastlane::Helper::SentryConfig).to receive(:parse_api_params).and_return(true)
+        expect(Fastlane::Helper::SentryHelper).to receive(:call_sentry_cli).with(anything, ["debug-files", "upload", "."]).and_return(true)
+
+        Fastlane::FastFile.new.parse("lane :test do
+            sentry_debug_files_upload(
+              auth_token: 'fixture-auth-token'
+            )
+        end").runner.execute(:test)
+      end
+
+      it "uses explicitly provided path over DSYM_OUTPUT_PATH" do
+        require 'fastlane'
+        mock_dsym_path = './assets/SwiftExample.app.dSYM.zip'
+        explicit_path = './explicit/path'
+
+        # Set the shared value, but explicit path should override it
+        Fastlane::Actions.lane_context[Fastlane::Actions::SharedValues::DSYM_OUTPUT_PATH] = mock_dsym_path
+
+        expect(Fastlane::Helper::SentryConfig).to receive(:parse_api_params).and_return(true)
+        expect(Fastlane::Helper::SentryHelper).to receive(:call_sentry_cli).with(anything, ["debug-files", "upload", explicit_path]).and_return(true)
+
+        Fastlane::FastFile.new.parse("lane :test do
+            sentry_debug_files_upload(
+              auth_token: 'fixture-auth-token',
+              path: '#{explicit_path}'
+            )
         end").runner.execute(:test)
       end