fastlane-plugin-sentry 0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 408b09f0cc6da0272b4c77e75f6e1ea49fcbc50f5983f6f0210956eacb1e4ebc
+  data.tar.gz: ecac9411e28c1af2e9374160b20d43641b39d8bcca1ac1a29362cfe18e7bf3aa
+SHA512:
+  metadata.gz: 00fa2b4a6df3ea509e1719d3b24e3d2192ab9dcae42430710e3f25a1a4dad15d78e4a0c543362a311a080fbeb51832cbaa75a51f1b6639e038f4c672c044bf2b
+  data.tar.gz: 85b72e5e2075b558a6d9d58586ef2ea2842af4019fb95078d82934fdf6470d412b5369182e6bf546bc69d5e435ebc1bcfbe1ea2166fa23dae623320fe5c8aa96

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,288 @@
+<p align="center">
+    <a href="https://sentry.io" target="_blank" align="center">
+        <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+    </a>
+<br/>
+    <h1>Sentry Fastlane Plugin</h1>
+</p>
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/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
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with fastlane-plugin-sentry, you can either add it globally for all projects, or locally to an individual project.
+
+### Globally
+
+If you install the gem globally, you can run it with any project that is setup for using `fastlane`.
+
+```bash
+gem install fastlane-plugin-sentry
+```
+
+Add the actions you want to use to your `Fastfile` file and call `fastlane` to run.
+
+### Locally
+
+You can also add the plugin for individual projects. Navigate to your project where `fastlane` is already set up and run the following command:
+
+```bash
+bundle exec fastlane add_plugin sentry
+```
+
+Fastlane will guide you through the process. It will add a `Pluginfile` where the sentry plugin is listed and also update the `Gemfile` and `Gemfile.lock` to include it as a dependency.
+
+```ruby
+# Autogenerated by fastlane
+#
+# Ensure this file is checked in to source control!
+
+gem 'fastlane-plugin-sentry'
+```
+
+Add the actions you want to use to your `Fastfile` file and call `bundle exec fastlane` to run.
+
+## Sentry Actions
+
+A subset of actions provided by the CLI: https://docs.sentry.io/learn/cli/
+
+### Authentication & Configuration
+
+`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_AUTH_TOKEN`, `SENTRY_ORG_SLUG`, and `SENTRY_PROJECT_SLUG`.
+
+### Uploading Debug Information Files
+
+```ruby
+sentry_debug_files_upload(
+  auth_token: '...',
+  org_slug: '...',
+  project_slug: '...',
+  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.
+)
+```
+
+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: 'bcsymbolmap', 'breakpad', 'dsym', 'elf', 'jvm', 'pdb', 'pe', 'portablepdb', 'sourcebundle', 'wasm'.
+- __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).
+- __id__: Optional. Search for specific debug identifiers.
+- __require_all__: Optional. Errors if not all identifiers specified with --id could be found.
+- __symbol_maps__: 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__: Optional. Do not search in ZIP files.
+- __no_upload__: Optional. Disable the actual upload. This runs all steps for the processing but does not trigger the upload. This is useful if you just want to verify the setup or skip the upload in tests.
+- __include_sources__: Optional. Include sources from the local file system and upload them as source bundles.
+- __wait__: Optional. Wait for the server to fully process uploaded files. Errors can only be displayed if --wait or --wait-for is specified, but this will significantly slow down the upload process.
+- __wait_for__: Optional. Wait for the server to fully process uploaded files, but at most for the given number of seconds. Errors can only be displayed if --wait or --wait-for is specified, but this will significantly slow down the upload process.
+- __il2cpp_mapping__: Optional. Compute il2cpp line mappings and upload them along with sources.
+
+### Uploading iOS Build Archives
+
+Upload iOS build archives (.xcarchive) to Sentry for improved symbolication and source context.
+
+```ruby
+sentry_upload_build(
+  auth_token: '...',
+  org_slug: '...',
+  project_slug: '...',
+  xcarchive_path: './build/MyApp.xcarchive', # Path to your .xcarchive file
+  # Optional git context parameters (can also be set via environment variables)
+  head_sha: 'abc123...', # The SHA of the head of the current branch (or SENTRY_HEAD_SHA)
+  base_sha: 'def456...', # The SHA of the base branch (or SENTRY_BASE_SHA)
+  vcs_provider: 'github', # Version control system provider (e.g., 'github', 'gitlab') (or SENTRY_VCS_PROVIDER)
+  head_repo_name: 'owner/repo-name', # Name of the head repository (or SENTRY_HEAD_REPO_NAME)
+  base_repo_name: 'owner/repo-name', # Name of the base repository (or SENTRY_BASE_REPO_NAME)
+  head_ref: 'feature-branch', # Name of the head branch (or SENTRY_HEAD_REF)
+  base_ref: 'main', # Name of the base branch (or SENTRY_BASE_REF)
+  pr_number: '123', # Pull request number (or SENTRY_PR_NUMBER)
+  build_configuration: 'Release', # Build configuration (e.g., 'Release', 'Debug') (or SENTRY_BUILD_CONFIGURATION)
+  release_notes: 'Fixed critical bugs', # Optional. Release notes to use for the upload
+  force_git_metadata: false, # Optional. Force collection and sending of git metadata
+  no_git_metadata: false # Optional. Disable collection and sending of git metadata
+)
+```
+
+By default the `SharedValue::XCODEBUILD_ARCHIVE` sets the `xcarchive_path` parameter if set by a prior lane such as `build_app`.
+
+This action is only supported on iOS platform.
+
+### Creating & Finalizing Releases
+
+```ruby
+sentry_create_release(
+  auth_token: '...',
+  org_slug: '...',
+  project_slug: '...',
+  version: '...', # release version to create
+  app_identifier: '...', # pass in the bundle_identifer of your app
+  finalize: true, # Whether to finalize the release. If not provided or false, the release can be finalized using the sentry_finalize_release action
+  release_url: 'https://github.com/owner/repo/releases/tag/v1.0.0' # Optional. URL to the release for information purposes
+)
+```
+
+### Uploading Files & Sourcemaps
+
+Useful for uploading build artifacts and JS sourcemaps for react-native apps built using fastlane.
+
+```ruby
+sentry_upload_sourcemap(
+  auth_token: '...',
+  org_slug: '...',
+  project_slug: '...',
+  version: '...',
+  app_identifier: '...', # pass in the bundle_identifer of your app
+  build: '...', # Optionally pass in the build number of your app
+  dist: '...', # optional distribution of the release usually the buildnumber
+  sourcemap: ['main.jsbundle', 'main.jsbundle.map'], # Sourcemap(s) to upload. Path(s) can be a comma-separated string or an array of strings.
+  rewrite: true, # Rewrite the sourcemaps before upload (default: false)
+  url_prefix: '~/', # Optional. Sets a URL prefix in front of all files
+  url_suffix: '.map', # Optional. Sets a URL suffix to append to all filenames
+  note: 'Build from CI', # Optional. Adds a note to the uploaded artifact bundle
+  validate: true, # Optional. Enable basic sourcemap validation
+  decompress: true, # Optional. Enable files gzip decompression prior to upload
+  wait: true, # Optional. Wait for the server to fully process uploaded files
+  wait_for: 60, # Optional. Wait for the server to fully process uploaded files, but at most for the given number of seconds
+  strict: true # Optional. Fail with a non-zero exit code if the specified source map file cannot be uploaded
+)
+```
+
+### Uploading Proguard Mapping File
+
+```ruby
+sentry_upload_proguard(
+  auth_token: '...',
+  org_slug: '...',
+  project_slug: '...',
+  mapping_path: 'path to mapping.txt to upload',
+  no_upload: false, # Optional. Disable the actual upload (useful for verification)
+  write_properties: 'path/to/properties/file', # Optional. Write UUIDs for processed mapping files into properties file
+  require_one: true, # Optional. Require at least one file to upload or the command will error
+  uuid: 'custom-uuid' # Optional. Explicitly override the UUID of the mapping file
+)
+```
+
+### 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
+  build: '...', # Optionally pass in the build number 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
+  ignore_missing: false, # Optional boolean value: When the flag is set and the previous release commit was not found in the repository, will create a release with the default commits count (or the one specified with `--initial-depth`) instead of failing the command.
+  local: false, # Optional. Set commits of a release from local git
+  initial_depth: 20 # Optional. Set the number of commits of the initial release (default: 20)
+)
+```
+
+### Create deploy
+
+Creates a new release deployment for a project on Sentry.
+
+```ruby
+sentry_create_deploy(
+  auth_token: '...',
+  org_slug: '...',
+  project_slug: '...',
+  version: '...',
+  app_identifier: '...', # pass in the bundle_identifer of your app
+  build: '...', # Optionally pass in the build number 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`
+)
+```
+
+### Specify custom sentry-cli path
+
+Starting with version `1.13.0`, the plugin bundles both macOS and Windows 64 bit executables of `sentry-cli`. You can also specify a custom `sentry-cli` path by adding `sentry_cli_path` to any action.
+
+### 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()
+```
+
+### Logging
+
+You can set the `sentry-cli` [configuration value](https://docs.sentry.io/product/cli/configuration/#configuration-values) `SENTRY_LOG_LEVEL` by adding `log_level` to any action. Supported values are 'trace', 'debug', 'info', 'warn' and 'error'.
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Migration Guide
+
+### Migrating from sentry-fastlane-plugin v1 to v2
+
+When upgrading to the latest version of this plugin (which uses sentry-cli v3), you may need to update your Fastfiles. Here are the key changes:
+
+#### Parameter Name Changes
+
+- **`sentry_debug_files_upload`**: The `ids` parameter has been renamed to `id` (singular). Update your Fastfiles:
+  ```ruby
+  # Before
+  sentry_debug_files_upload(ids: 'abc123')
+  
+  # After
+  sentry_debug_files_upload(id: 'abc123')
+  ```
+
+#### Removed Parameters
+
+The following parameters have been removed as they are no longer supported in sentry-cli v3:
+
+- **`sentry_debug_files_upload`**: Remove `info_plist`, `no_reprocessing`, and `upload_symbol_maps` parameters if you're using them.
+- **`sentry_upload_proguard`**: Remove `android_manifest_path` parameter if you're using it (no longer needed).
+
+#### New Available Options
+
+Many new options have been added to match sentry-cli v3 capabilities. See the action documentation above for all available options. Some notable additions:
+
+- **`sentry_debug_files_upload`**: Added `wait_for`, `no_upload`, `il2cpp_mapping` options. Type validation now includes `jvm`, `portablepdb`, and `wasm`.
+- **`sentry_upload_sourcemap`**: Added `url_suffix`, `note`, `validate`, `decompress`, `wait`, `wait_for`, `no_sourcemap_reference`, `debug_id_reference`, `bundle`, `bundle_sourcemap`, `ext`, and `strict` options.
+- **`sentry_upload_proguard`**: Added `no_upload`, `write_properties`, `require_one`, and `uuid` options.
+- **`sentry_upload_build`**: Added `release_notes`, `force_git_metadata`, and `no_git_metadata` options.
+- **`sentry_create_release`**: Added `url` option.
+- **`sentry_finalize_release`**: Added `url` and `released` options.
+- **`sentry_set_commits`**: Added `local` and `initial_depth` options.
+
+#### Removed Actions
+
+The following actions have been removed and replaced:
+
+- **`sentry_upload_file`**: Use `sentry_upload_sourcemap` for source maps or other specialized upload actions.
+- **`sentry_upload_dsym`**: Use `sentry_debug_files_upload` with appropriate `path` parameter.
+- **`sentry_upload_dif`**: Use `sentry_debug_files_upload` with appropriate `path` parameter.
+
+For more details on sentry-cli v3 changes, see the [sentry-cli 3.0.0 release notes](https://github.com/getsentry/sentry-cli/releases/tag/3.0.0).
+
+## Troubleshooting
+
+For some more detailed help with plugins problems, check out the [Plugins Troubleshooting](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+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`
+
+`fastlane` automates building, testing, and releasing your app for beta and app store distributions. To learn more about `fastlane`, check out [fastlane.tools](https://fastlane.tools).

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

@@ -0,0 +1,41 @@
+module Fastlane
+  module Actions
+    class SentryCheckCliInstalledAction < Action
+      def self.run(params)
+        Helper::SentryHelper.find_and_check_sentry_cli_path!(params)
+        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
+
+      def self.available_options
+        Helper::SentryConfig.common_cli_config_items
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+module Fastlane
+  module Actions
+    class SentryCreateDeployAction < 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]
+
+        command = [
+          "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(params, 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: :app_identifier,
+                                       short_option: "-a",
+                                       env_name: "SENTRY_APP_IDENTIFIER",
+                                       description: "App Bundle Identifier, prepended with the version.\nFor example bundle@version",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :build,
+                                       short_option: "-b",
+                                       description: "Release build to associate the deploy with on Sentry",
+                                       optional: true),
+          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)
+        ]
+      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

@@ -0,0 +1,77 @@
+module Fastlane
+  module Actions
+    class SentryCreateReleaseAction < 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]
+
+        command = [
+          "releases",
+          "new",
+          version
+        ]
+        command.push("--finalize") if params[:finalize] == true
+        command.push("--url").push(params[:release_url]) unless params[:release_url].nil?
+
+        Helper::SentryHelper.call_sentry_cli(params, command)
+        UI.success("Successfully created release: #{version}")
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Create new releases for a project on Sentry"
+      end
+
+      def self.details
+        [
+          "This action allows you to create new releases for a project on Sentry.",
+          "See https://docs.sentry.io/learn/cli/releases/#creating-releases for more information."
+        ].join(" ")
+      end
+
+      def self.available_options
+        Helper::SentryConfig.common_api_config_items + [
+          FastlaneCore::ConfigItem.new(key: :version,
+                                       description: "Release version to create 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 to create on Sentry",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :finalize,
+                                       description: "Whether to finalize the release. If not provided or false, the release can be finalized using the finalize_release action",
+                                       default_value: false,
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :release_url,
+                                       description: "Optional URL to the release for information purposes",
+                                       optional: true)
+        ]
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.authors
+        ["wschurman"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end