fastlane-plugin-sentry 1.5.0 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 694c6c0337c64891bf86878741bbb9442a0ce79d
-  data.tar.gz: 310fbe02e5192aaf65e293d8a8f02c27803324bf
+SHA256:
+  metadata.gz: 997460b2dd7418643a318ce88f9ecf72e45a087e11ca1bfbb50da96ed9ec1fc6
+  data.tar.gz: cbfdbe73533b999f88124548a5e458989f2f599e3621fd7ab9b89500de37e573
 SHA512:
-  metadata.gz: f70d09887c83a79c057db0dc6af8a52da136fe2d4abc0f1079cf9491e8b9ee41ce30f0bbd4f3dbf38987205ba966cd5caa26155f455228b77a83e0c521b608a8
-  data.tar.gz: 7ae2b77c6376bef7834bebbf403eaa35ab4d5330e62e2e96c33a3c19ca5ad10ef43d6f35235b3f2e3ca6b72c98dc93881486e159170ad3acfe65b4be1e21224c
+  metadata.gz: b8f36f2206339e9f133b882a2fe52fb7961488784811e3d5f1c1af311bb584c5332079a697f9aad98e05c6b3845d7057b4892a1a1c1cfbf5eec888760718c6d1
+  data.tar.gz: db320f54c60e647f31ab222d0190eb3c82d480726832df20ebe62638edabeecf0d5610990e5cf20e044c148defa727c947bdd665f91e9dc10b3dacac3d743653

data/README.md

@@ -7,7 +7,7 @@
 </p>
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-sentry)
-[![Build Status](https://img.shields.io/travis/getsentry/fastlane-plugin-sentry/master.svg?style=flat)](https://travis-ci.org/getsentry/fastlane-plugin-sentry)
+[![Tests](https://img.shields.io/github/workflow/status/getsentry/sentry-fastlane/test?label=Tests)](https://github.com/getsentry/sentry-fastlane/actions?query=workflow%3A"test")
 [![Gem Version](https://badge.fury.io/rb/fastlane-plugin-sentry.svg)](https://badge.fury.io/rb/fastlane-plugin-sentry)
 
 ## Getting Started
@@ -38,7 +38,7 @@ sentry_upload_dsym(
   auth_token: '...', # Do not use if using api_key
   org_slug: '...',
   project_slug: '...',
-  symbol_maps: 'path to bcsymbols folder' # use this if you have a bcsymbols folder
+  symbol_maps: 'path to bcsymbols folder', # use this if you have a bcsymbols folder
   dsym_path: './App.dSYM.zip',
   info_plist: '...' # optional, sentry-cli tries to find the correct plist by itself
 )
@@ -91,6 +91,54 @@ sentry_upload_sourcemap(
 )
 ```
 
+#### Uploading Proguard Mapping File
+
+```ruby
+sentry_upload_proguard(
+  api_key: '...', # Do not use if using auth_token
+  auth_token: '...', # Do not use if using api_key
+  org_slug: '...',
+  project_slug: '...',
+  android_manifest_path: 'path to merged AndroidManifest file' # found in `app/build/intermediates/manifests/full`
+  mapping_path: 'path to mapping.txt to upload',
+)
+```
+
+#### Associating commits
+
+Useful for telling Sentry which commits are associated with a release.
+
+```ruby
+sentry_set_commits(
+  version: '...',
+  app_identifier: '...', # pass in the bundle_identifer of your app
+  auto: false, # enable completely automated commit management
+  clear: false, # clear all current commits from the release
+  commit: '...', # commit spec, see `sentry-cli releases help set-commits` for more information
+)
+```
+
+#### Create deploy
+
+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
+  org_slug: '...',
+  project_slug: '...',
+  version: '...',
+  app_identifier: '...', # pass in the bundle_identifer of your app
+  env: 'staging', # The environment for this deploy. Required.
+  name: '...', # Optional human readable name
+  deploy_url: '...', # Optional URL that points to the deployment
+  started: 1622630647, # Optional unix timestamp when the deployment started
+  finished: 1622630700, # Optional unix timestamp when the deployment finished
+  time: 180 # Optional deployment duration in seconds. This can be specified alternatively to `started` and `finished`
+)
+```
+
 ## Issues and Feedback
 
 For any other issues and feedback about this plugin, please submit it to this repository.
@@ -101,7 +149,7 @@ For some more detailed help with plugins problems, check out the [Plugins Troubl
 
 ## Using `fastlane` Plugins
 
-For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md) in the main `fastlane` repo.
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/) in the main `fastlane` repo.
 
 ## About `fastlane`
 

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

@@ -0,0 +1,95 @@
+module Fastlane
+  module Actions
+    class SentryCreateDeployAction < Action
+      def self.run(params)
+        require 'shellwords'
+
+        Helper::SentryHelper.check_sentry_cli!
+        Helper::SentryConfig.parse_api_params(params)
+
+        version = params[:version]
+        version = "#{params[:app_identifier]}@#{params[:version]}" if params[:app_identifier]
+
+        command = [
+          "sentry-cli",
+          "releases",
+          "deploys",
+          version,
+          "new"
+        ]
+        command.push('--env').push(params[:env]) unless params[:env].nil?
+        command.push('--name').push(params[:name]) unless params[:name].nil?
+        command.push('--url').push(params[:deploy_url]) unless params[:deploy_url].nil?
+        command.push('--started').push(params[:started]) unless params[:started].nil?
+        command.push('--finished').push(params[:finished]) unless params[:finished].nil?
+        command.push('--time').push(params[:time]) unless params[:time].nil?
+
+        Helper::SentryHelper.call_sentry_cli(command)
+        UI.success("Successfully created deploy: #{version}")
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Creates a new release deployment for a project on Sentry"
+      end
+
+      def self.details
+        [
+          "This action allows you to associate deploys to releases for a project on Sentry.",
+          "See https://docs.sentry.io/product/cli/releases/#creating-deploys for more information."
+        ].join(" ")
+      end
+
+      def self.available_options
+        Helper::SentryConfig.common_api_config_items + [
+          FastlaneCore::ConfigItem.new(key: :version,
+                                       description: "Release version to associate the deploy with on Sentry"),
+          FastlaneCore::ConfigItem.new(key: :env,
+                                       short_option: "-e",
+                                       description: "Set the environment for this release. This argument is required. Values that make sense here would be 'production' or 'staging'",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :name,
+                                       short_option: "-n",
+                                       description: "Optional human readable name for this deployment",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :deploy_url,
+                                       description: "Optional URL that points to the deployment",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :started,
+                                       description: "Optional unix timestamp when the deployment started",
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :finished,
+                                       description: "Optional unix timestamp when the deployment finished",
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :time,
+                                       short_option: "-t",
+                                       description: "Optional deployment duration in seconds. This can be specified alternatively to `started` and `finished`",
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                       short_option: "-a",
+                                       env_name: "SENTRY_APP_IDENTIFIER",
+                                       description: "App Bundle Identifier, prepended with the version.\nFor example bundle@version",
+                                       optional: true)
+        ]
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.authors
+        ["denrase"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module Fastlane
         Helper::SentryConfig.parse_api_params(params)
 
         version = params[:version]
-        version = "#{params[:app_identifier]}-#{params[:version]}" if params[:app_identifier]
+        version = "#{params[:app_identifier]}@#{params[:version]}" if params[:app_identifier]
 
         command = [
           "sentry-cli",

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

@@ -8,7 +8,7 @@ module Fastlane
         Helper::SentryConfig.parse_api_params(params)
 
         version = params[:version]
-        version = "#{params[:app_identifier]}-#{params[:version]}" if params[:app_identifier]
+        version = "#{params[:app_identifier]}@#{params[:version]}" if params[:app_identifier]
 
         command = [
           "sentry-cli",

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

@@ -0,0 +1,79 @@
+module Fastlane
+  module Actions
+    class SentrySetCommitsAction < Action
+      def self.run(params)
+        require 'shellwords'
+
+        Helper::SentryHelper.check_sentry_cli!
+        Helper::SentryConfig.parse_api_params(params)
+
+        version = params[:version]
+        version = "#{params[:app_identifier]}@#{params[:version]}" if params[:app_identifier]
+
+        command = [
+          "sentry-cli",
+          "releases",
+          "set-commits",
+          version
+        ]
+
+        command.push('--auto') if params[:auto]
+        command.push('--clear') if params[:clear]
+        command.push('--commit').push(params[:commit]) unless params[:commit].nil?
+
+        Helper::SentryHelper.call_sentry_cli(command)
+        UI.success("Successfully set commits for release: #{version}")
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Set commits of a release"
+      end
+
+      def self.details
+        [
+          "This action allows you to set commits in a release for a project on Sentry.",
+          "See https://docs.sentry.io/cli/releases/#sentry-cli-commit-integration 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: :auto,
+                                      description: "Enable completely automated commit management",
+                                      is_string: false,
+                                      default_value: false),
+          FastlaneCore::ConfigItem.new(key: :clear,
+                                      description: "Clear all current commits from the release",
+                                      is_string: false,
+                                      default_value: false),
+          FastlaneCore::ConfigItem.new(key: :commit,
+                                      description: "Commit spec, see `sentry-cli releases help set-commits` for more information",
+                                      optional: true)
+        ]
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.authors
+        ["brownoxford"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ module Fastlane
         file = params[:file]
 
         version = params[:version]
-        version = "#{params[:app_identifier]}-#{params[:version]}" if params[:app_identifier]
+        version = "#{params[:app_identifier]}@#{params[:version]}" if params[:app_identifier]
 
         command = [
           "sentry-cli",

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

@@ -0,0 +1,75 @@
+module Fastlane
+  module Actions
+    class SentryUploadProguardAction < Action
+      def self.run(params)
+        Helper::SentryHelper.check_sentry_cli!
+        Helper::SentryConfig.parse_api_params(params)
+
+        # Params - mapping & manifest
+        mapping_path = params[:mapping_path]
+        android_manifest_path = params[:android_manifest_path]
+
+        # Verify files
+        UI.user_error!("Mapping file does not exist at path: #{mapping_path}") unless File.exist? mapping_path
+        UI.user_error!("AndroidManifest.xml file does not exist at path: #{android_manifest_path}") unless File.exist? android_manifest_path
+
+        command = [
+          "sentry-cli",
+          "upload-proguard",
+          "--android-manifest",
+          android_manifest_path,
+          mapping_path
+        ]
+
+        Helper::SentryHelper.call_sentry_cli(command)
+        UI.success("Successfully uploaded mapping file!")
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Upload mapping to a project on Sentry"
+      end
+
+      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."
+        ].join(" ")
+      end
+
+      def self.available_options
+        Helper::SentryConfig.common_api_config_items + [
+          FastlaneCore::ConfigItem.new(key: :mapping_path,
+                                      env_name: "ANDROID_MAPPING_PATH",
+                                      description: "Path to your proguard mapping.txt file",
+                                      optional: false,
+                                      verify_block: proc do |value|
+                                        UI.user_error! "Could not find your mapping file at path '#{value}'" unless File.exist?(value)
+                                      end),
+          FastlaneCore::ConfigItem.new(key: :android_manifest_path,
+                                      env_name: "ANDROID_MANIFEST_PATH",
+                                      description: "Path to your merged AndroidManifest file. This is usually found under `app/build/intermediates/manifests/full`",
+                                      optional: false,
+                                      verify_block: proc do |value|
+                                        UI.user_error! "Could not find your merged AndroidManifest file at path '#{value}'" unless File.exist?(value)
+                                      end)
+        ]
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.authors
+        ["mpp-anasa"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

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

@@ -10,23 +10,36 @@ module Fastlane
         version = params[:version]
         sourcemap = params[:sourcemap]
 
-        version = "#{params[:app_identifier]}-#{params[:version]}" if params[:app_identifier]
+        version = "#{params[:app_identifier]}@#{params[:version]}" if params[:app_identifier]
 
         command = [
           "sentry-cli",
           "releases",
           "files",
-          Shellwords.escape(version),
+          version,
           "upload-sourcemaps",
           sourcemap.to_s
         ]
 
         command.push('--rewrite') if params[:rewrite]
+        command.push('--no-rewrite') unless params[:rewrite]
         command.push('--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('--dist').push(params[:dist]) unless params[:dist].nil?
 
+        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! { |e| e.strip.empty? rescue true }
+          command.push('--ignore').push(*params[:ignore]) if params[:ignore].any?
+        end
+
+        command.push('--ignore-file').push(params[:ignore_file]) unless params[:ignore_file].nil?
+
         Helper::SentryHelper.call_sentry_cli(command)
         UI.success("Successfully uploaded files to release: #{version}")
       end
@@ -82,6 +95,13 @@ module Fastlane
                                        short_option: "-a",
                                        env_name: "SENTRY_APP_IDENTIFIER",
                                        description: "App Bundle Identifier, prepended to version",
+                                       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)
 
         ]

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

@@ -41,12 +41,13 @@ module Fastlane
         has_api_key = !api_key.to_s.empty?
         has_auth_token = !auth_token.to_s.empty?
 
-        skip_params_check = false
-        if !has_org || !has_project || !has_auth_token
-          skip_params_check = fallback_sentry_cli
-        end
+        ENV['SENTRY_URL'] = url unless url.to_s.empty?
+        ENV['SENTRY_LOG_LEVEL'] = 'INFO' if FastlaneCore::Globals.verbose?
 
-        if !skip_params_check
+        # Fallback to .sentryclirc if possible when no auth token is provided
+        if !has_api_key && !has_auth_token && fallback_sentry_cli_auth
+            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'`")
@@ -57,21 +58,20 @@ module Fastlane
           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?
-          ENV['SENTRY_URL'] = url unless url.to_s.empty?
-          ENV['SENTRY_LOG_LEVEL'] = 'INFO' if FastlaneCore::Globals.verbose?
+        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?
         else
-          UI.important("No config provided, will fallback to .sentryclirc")
+          UI.important("No org/project config provided, will fallback to .sentryclirc")
         end
       end
 
-      def self.fallback_sentry_cli
+      def self.fallback_sentry_cli_auth
         sentry_cli_result = JSON.parse(`sentry-cli info --config-status-json`)
         return (sentry_cli_result["auth"]["successful"] &&
-          !sentry_cli_result["auth"]["type"].nil? &&
-          !sentry_cli_result["config"]["org"].nil? &&
-          !sentry_cli_result["config"]["project"].nil?)
+          !sentry_cli_result["auth"]["type"].nil?)
       end
     end
   end

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

@@ -33,12 +33,12 @@ module Fastlane
         end
         final_command = command.map { |arg| Shellwords.escape(arg) }.join(" ")
         Open3.popen3(final_command) do |stdin, stdout, stderr, wait_thr|
-          while (line = stderr.gets)
-            error << line.strip!
-          end
           while (line = stdout.gets)
             UI.message(line.strip!)
           end
+          while (line = stderr.gets)
+            error << line.strip!
+          end
           exit_status = wait_thr.value
           unless exit_status.success? && error.empty?
             handle_error(error)

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

@@ -1,6 +1,6 @@
 module Fastlane
   module Sentry
-    VERSION = "1.5.0"
-    CLI_VERSION = "1.31.0"
+    VERSION = "1.8.2"
+    CLI_VERSION = "1.63.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-sentry
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.8.2
 platform: ruby
 authors:
 - Sentry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -89,10 +89,13 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/sentry.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
+- lib/fastlane/plugin/sentry/actions/sentry_set_commits.rb
 - lib/fastlane/plugin/sentry/actions/sentry_upload_dsym.rb
 - lib/fastlane/plugin/sentry/actions/sentry_upload_file.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
@@ -116,8 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Upload symbols to Sentry