feat!: Remove deprecated parameters api_key and force_foreground (#376)

philprime · web-flow · commit 8355581619fd · 2026-01-09T09:34:09.000Z
BREAKING CHANGE: Remove deprecated parameters api_key and force_foreground.

- Remove api_key parameter from sentry_config.rb
- Remove SENTRY_API_KEY environment variable support
- Remove force_foreground parameter from sentry_debug_files_upload.rb
- Update all spec files to use auth_token instead of api_key
- Remove force_foreground test from spec
- Update README.md to remove api_key and force_foreground mentions
- Update CHANGELOG.md with breaking changes

Users should migrate from api_key to auth_token for authentication.
Users should remove force_foreground parameter from their Fastfiles.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,8 @@ 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.
+- **`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))
 - **`sentry_upload_dif` 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))
 
diff --git a/README.md b/README.md
@@ -50,18 +50,16 @@ A subset of actions provided by the CLI: https://docs.sentry.io/learn/cli/
 
 ### Authentication & Configuration
 
-`auth_token` is the preferred 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.
+`auth_token` is the authentication method with Sentry. This can be obtained on https://sentry.io/api/.
 Also note that as of version `1.2.0` you no longer have to provide the required parameters, we will try to fallback to your `.sentryclirc` config file if possible.
 
-The following environment variables may be used in place of parameters: `SENTRY_API_KEY`, `SENTRY_AUTH_TOKEN`, `SENTRY_ORG_SLUG`, and `SENTRY_PROJECT_SLUG`.
+The following environment variables may be used in place of parameters: `SENTRY_AUTH_TOKEN`, `SENTRY_ORG_SLUG`, and `SENTRY_PROJECT_SLUG`.
 
 ### Uploading Debug Information Files
 
 ```ruby
 sentry_debug_files_upload(
-  api_key: '...', # Do not use if using auth_token
-  auth_token: '...', # Do not use if using api_key
+  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.
@@ -83,7 +81,6 @@ Further options:
 - __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. __Deprecated NoOp since 1.26.0. Before v 1.26.0__: 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.
@@ -94,8 +91,7 @@ Upload iOS build archives (.xcarchive) to Sentry for improved symbolication and
 
 ```ruby
 sentry_upload_build(
-  api_key: '...', # Do not use if using auth_token
-  auth_token: '...', # Do not use if using api_key
+  auth_token: '...',
   org_slug: '...',
   project_slug: '...',
   xcarchive_path: './build/MyApp.xcarchive', # Path to your .xcarchive file
@@ -120,7 +116,6 @@ This action is only supported on iOS platform.
 
 ```ruby
 sentry_create_release(
-  api_key: '...',
   auth_token: '...',
   org_slug: '...',
   project_slug: '...',
@@ -136,7 +131,6 @@ Useful for uploading build artifacts and JS sourcemaps for react-native apps bui
 
 ```ruby
 sentry_upload_sourcemap(
-  api_key: '...',
   auth_token: '...',
   org_slug: '...',
   project_slug: '...',
@@ -153,8 +147,7 @@ sentry_upload_sourcemap(
 
 ```ruby
 sentry_upload_proguard(
-  api_key: '...', # Do not use if using auth_token
-  auth_token: '...', # Do not use if using api_key
+  auth_token: '...',
   org_slug: '...',
   project_slug: '...',
   android_manifest_path: 'path to merged AndroidManifest file', # found in `app/build/intermediates/manifests/full`
@@ -184,8 +177,7 @@ Creates a new release deployment for a project on Sentry.
 
 ```ruby
 sentry_create_deploy(
-  api_key: '...', # Do not use if using auth_token
-  auth_token: '...', # Do not use if using api_key
+  auth_token: '...',
   org_slug: '...',
   project_slug: '...',
   version: '...',
diff --git a/lib/fastlane/plugin/sentry/actions/sentry_debug_files_upload.rb b/lib/fastlane/plugin/sentry/actions/sentry_debug_files_upload.rb
@@ -26,7 +26,6 @@ def self.run(params)
         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] != true
         command.push('--wait') unless params[:wait].nil?
         command.push('--upload-symbol-maps') unless params[:upload_symbol_maps].nil?
@@ -120,15 +119,6 @@ def self.available_options
                                        description: "Do not trigger reprocessing after uploading",
                                        is_string: false,
                                        optional: true),
-          FastlaneCore::ConfigItem.new(key: :force_foreground,
-                                       description: "Wait for the process to finish.{n}\
-                                       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",
-                                       is_string: false,
-                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :include_sources,
                                        description: "Include sources from the local file system and upload \
                                        them as source bundles",
diff --git a/lib/fastlane/plugin/sentry/helper/sentry_config.rb b/lib/fastlane/plugin/sentry/helper/sentry_config.rb
@@ -24,10 +24,6 @@ def self.common_api_config_items
                                        env_name: "SENTRY_AUTH_TOKEN",
                                        description: "Authentication token for Sentry",
                                        optional: true),
-          FastlaneCore::ConfigItem.new(key: :api_key,
-                                       env_name: "SENTRY_API_KEY",
-                                       description: "API key for Sentry",
-                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :org_slug,
                                        env_name: "SENTRY_ORG_SLUG",
                                        description: "Organization slug for Sentry project",
@@ -51,14 +47,12 @@ def self.parse_api_params(params)
 
         url = params[:url]
         auth_token = params[:auth_token]
-        api_key = params[:api_key]
         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_api_key = !api_key.to_s.empty?
         has_auth_token = !auth_token.to_s.empty?
 
         ENV['SENTRY_URL'] = url unless url.to_s.empty?
@@ -70,18 +64,13 @@ def self.parse_api_params(params)
         end
 
         # Fallback to .sentryclirc if possible when no auth token is provided
-        if !has_api_key && !has_auth_token && fallback_sentry_cli_auth(params)
+        if !has_auth_token && fallback_sentry_cli_auth(params)
           UI.important("No auth config provided, will fallback to .sentryclirc")
         else
-          # Will fail if none or both authentication methods are provided
-          if !has_api_key && !has_auth_token
-            UI.user_error!("No API key or authentication token found for SentryAction given, pass using `api_key: 'key'` or `auth_token: 'token'`")
-          elsif has_api_key && has_auth_token
-            UI.user_error!("Both API key and authentication token found for SentryAction given, please only give one")
-          elsif has_api_key && !has_auth_token
-            UI.deprecated("Please consider switching to auth_token ... api_key will be removed in the future")
+          # 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_API_KEY'] = api_key unless api_key.to_s.empty?
           ENV['SENTRY_AUTH_TOKEN'] = auth_token unless auth_token.to_s.empty?
         end
 
diff --git a/spec/sentry_config_spec.rb b/spec/sentry_config_spec.rb
@@ -8,46 +8,47 @@
 
   describe "parse_api_params" do
     it "does not set env if no value" do
-      Fastlane::Helper::SentryConfig.parse_api_params({ api_key: 'fixture-api-key' })
+      Fastlane::Helper::SentryConfig.parse_api_params({ auth_token: 'fixture-auth-token' })
       expect(ENV['SENTRY_LOG_LEVEL']).to be_nil
     end
 
     it "sets debug env if Fastlane is set to verbose" do
       FastlaneCore::Globals.verbose = true
-      Fastlane::Helper::SentryConfig.parse_api_params({ api_key: 'fixture-api-key' })
+      Fastlane::Helper::SentryConfig.parse_api_params({ auth_token: 'fixture-auth-token' })
       expect(ENV['SENTRY_LOG_LEVEL']).to eq('debug')
     end
 
     it "sets trace env" do
-      Fastlane::Helper::SentryConfig.parse_api_params({ api_key: 'fixture-api-key', log_level: 'trace' })
+      Fastlane::Helper::SentryConfig.parse_api_params({ auth_token: 'fixture-auth-token', log_level: 'trace' })
       expect(ENV['SENTRY_LOG_LEVEL']).to eq('trace')
     end
 
     it "sets debug env" do
-      Fastlane::Helper::SentryConfig.parse_api_params({ api_key: 'fixture-api-key', log_level: 'debug' })
+      Fastlane::Helper::SentryConfig.parse_api_params({ auth_token: 'fixture-auth-token', log_level: 'debug' })
       expect(ENV['SENTRY_LOG_LEVEL']).to eq('debug')
     end
 
     it "sets info env" do
-      Fastlane::Helper::SentryConfig.parse_api_params({ api_key: 'fixture-api-key', log_level: 'info' })
+      Fastlane::Helper::SentryConfig.parse_api_params({ auth_token: 'fixture-auth-token', log_level: 'info' })
       expect(ENV['SENTRY_LOG_LEVEL']).to eq('info')
     end
 
     it "sets warn env" do
-      Fastlane::Helper::SentryConfig.parse_api_params({ api_key: 'fixture-api-key', log_level: 'warn' })
+      Fastlane::Helper::SentryConfig.parse_api_params({ auth_token: 'fixture-auth-token', log_level: 'warn' })
       expect(ENV['SENTRY_LOG_LEVEL']).to eq('warn')
     end
 
     it "sets error env" do
-      Fastlane::Helper::SentryConfig.parse_api_params({ api_key: 'fixture-api-key', log_level: 'error' })
+      Fastlane::Helper::SentryConfig.parse_api_params({ auth_token: 'fixture-auth-token', log_level: 'error' })
       expect(ENV['SENTRY_LOG_LEVEL']).to eq('error')
     end
 
     it "raise error on invalid log_level" do
       expect do
         Fastlane::FastFile.new.parse("lane :test do
           sentry_debug_files_upload(
-            api_key: 'fixture-api-key',
+            auth_token: 'fixture-auth-token',
+            path: 'fixture-path',
             log_level: 'unknown'
           )
         end").runner.execute(:test)
diff --git a/spec/sentry_debug_files_upload_spec.rb b/spec/sentry_debug_files_upload_spec.rb
@@ -260,18 +260,6 @@
         end").runner.execute(:test)
       end
 
-      it "includes --force_foreground when true" do
-        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", "fixture-path", "--force-foreground"]).and_return(true)
-
-        Fastlane::FastFile.new.parse("lane :test do
-            sentry_debug_files_upload(
-              path: 'fixture-path',
-              force_foreground: true
-            )
-        end").runner.execute(:test)
-      end
-
       it "includes --include_sources when true" do
         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", "fixture-path", "--include-sources"]).and_return(true)
diff --git a/spec/sentry_upload_proguard_spec.rb b/spec/sentry_upload_proguard_spec.rb
@@ -1,29 +1,14 @@
 describe Fastlane do
   describe Fastlane::FastFile do
     describe "upload proguard" do
-      it "fails with API key and auth token" do
-        mapping_path = File.absolute_path './assets/AndroidExample.mapping.txt'
-
-        expect do
-          Fastlane::FastFile.new.parse("lane :test do
-            sentry_upload_proguard(
-              org_slug: 'some_org',
-              api_key: 'something123',
-              auth_token: 'something123',
-              project_slug: 'some_project',
-              mapping_path: '#{mapping_path}')
-          end").runner.execute(:test)
-        end.to raise_error("Both API key and authentication token found for SentryAction given, please only give one")
-      end
-
       it "fails with invalid mapping path" do
         mapping_path = File.absolute_path './assets/this.does.not.exist.mapping.txt'
 
         expect do
           Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_proguard(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               mapping_path: '#{mapping_path}')
           end").runner.execute(:test)
diff --git a/spec/sentry_upload_sourcemap_spec.rb b/spec/sentry_upload_sourcemap_spec.rb
@@ -7,7 +7,7 @@
           Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_sourcemap(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               sourcemap: '#{sourcemap_path}')
           end").runner.execute(:test)
@@ -24,7 +24,7 @@
         Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_sourcemap(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               version: '1.0',
               sourcemap: '1.map',
@@ -43,7 +43,7 @@
         Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_sourcemap(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               version: '1.0',
               dist: 'dem',
@@ -63,7 +63,7 @@
         Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_sourcemap(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               version: '1.0',
               dist: 'dem',
@@ -83,7 +83,7 @@
         Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_sourcemap(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               version: '1.0',
               dist: 'dem',
@@ -105,7 +105,7 @@
         Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_sourcemap(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               version: '1.0',
               dist: 'dem',
@@ -126,7 +126,7 @@
         Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_sourcemap(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               version: '1.0',
               dist: 'dem',
@@ -145,7 +145,7 @@
         Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_sourcemap(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               version: '1.0',
               dist: 'dem',
@@ -163,7 +163,7 @@
         Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_sourcemap(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               version: '1.0',
               dist: 'dem',
@@ -184,7 +184,7 @@
         Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_sourcemap(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               version: '1.0',
               dist: 'dem',
@@ -205,7 +205,7 @@
         Fastlane::FastFile.new.parse("lane :test do
             sentry_upload_sourcemap(
               org_slug: 'some_org',
-              api_key: 'something123',
+              auth_token: 'something123',
               project_slug: 'some_project',
               version: '1.0',
               dist: 'dem',
