fastlane-plugin-luciq_dsym_upload 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2befc48ee21b15bf7861ebd08458832b530d2effffa9711bab327ecff76e09dd
+  data.tar.gz: 03da6b0e4e6d8637f22705c4a0dffebfb7245e28c2a56274a343ef206f0dd63f
+SHA512:
+  metadata.gz: 78229d9419c94b7369d478dc811d9f4489392de816e3e39faa00607384d4c0dfb7f6a46a5341593434c30015b6c3d96d454a971b09b19ec02773eee5334ac2c0
+  data.tar.gz: 6cbfe5e5cd1ace2a1e2b0c0932384fb911dbf6afb378e84b1ccd357eebc296f6b8e82b92ceff60041343f4130c045d039412a2a7d7f20ab859fa53e0fc1a780e

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Luciq <contactus@luciq.ai>
+
+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,94 @@
+# fastlane-plugin-luciq\_dsym\_upload
+
+[](https://rubygems.org/gems/fastlane-plugin-luciq_dsym_upload)
+
+## About This Plugin
+
+The `luciq_dsym_upload` plugin for [fastlane](https://fastlane.tools) provides a streamlined way to upload dSYM symbolication files directly to Luciq. This is essential for debugging and analyzing crash reports.
+
+This action integrates seamlessly into your CI/CD workflow. You can use it with `gym` to upload dSYMs generated during the build process, or with `download_dsyms` if you have Bitcode enabled and need to fetch the dSYMs from Apple's App Store Connect first.
+
+-----
+
+## Getting Started
+
+To get started, add the `luciq_dsym_upload` plugin to your project by running this command in your terminal:
+
+```bash
+fastlane add_plugin luciq_dsym_upload
+```
+
+-----
+
+## Usage
+
+Integrate the `luciq_dsym_upload` action into your `Fastfile`. Below are some common usage examples.
+
+### Basic Upload
+
+The simplest use case is to provide your Luciq token. The plugin will automatically find and upload the dSYM file generated by a preceding `gym` or `download_dsyms` action.
+
+```ruby
+# In your Fastfile
+
+lane :release do
+  gym
+  luciq_dsym_upload(api_token: "<Your Luciq token>")
+end
+```
+
+### Uploading Specific dSYM Files
+
+If you need to upload specific dSYM files from custom paths, use the `dsym_array_paths` parameter.
+
+```ruby
+luciq_dsym_upload(
+  api_token: "<Your Luciq token>",
+  dsym_array_paths: ["./App1.dSYM.zip", "./App2.dSYM.zip"]
+)
+```
+
+### Targeting the EU Cluster
+
+If your organization uses Luciq's EU data cluster, set the `eu` parameter to `true`.
+
+```ruby
+luciq_dsym_upload(
+  api_token: "<Your Luciq token>",
+  eu: true
+)
+```
+
+### Using a Custom Endpoint
+
+For custom or on-premise setups, you can specify a different API endpoint using the `end_point` parameter.
+
+```ruby
+luciq_dsym_upload(
+  api_token: "<Your Luciq token>",
+  end_point: "https://api.luciq.ai/api/sdk/v3/symbols_files"
+)
+```
+
+-----
+
+## Parameters
+
+| Key | Description | Required | Default Value |
+| --- | --- | --- | --- |
+| `api_token` | Your API token for Luciq. | Yes | - |
+| `dsym_array_paths` | An array of paths to specific `.dSYM.zip` files you want to upload. | No | Automatically detected |
+| `eu` | Set to `true` if you are using the EU cluster in the Luciq SDK. | No | `false` |
+| `end_point` | The custom API endpoint for dSYM uploads. | No | Luciq's default endpoint |
+
+-----
+
+## Issues and Feedback
+
+If you encounter any issues or have feedback for this plugin, please [submit an issue](https://github.com/luciqai/fastlane-plugin-luciq_dsym_upload/issues) to this repository.
+
+For general troubleshooting with *fastlane* plugins, please review the official [Plugins Troubleshooting Guide](https://docs.fastlane.tools/plugins/plugins-troubleshooting/).
+
+## About *fastlane*
+
+*fastlane* is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/luciq_dsym_upload/actions/luciq_dsym_upload_action.rb

@@ -0,0 +1,151 @@
+require 'fileutils'
+require 'fastlane/action'
+require_relative '../helper/luciq_dsym_upload_helper'
+require 'shellwords'
+
+module Fastlane
+  module Actions
+    class LuciqDsymUploadAction < Action
+      def self.run(params)
+        @luciq_dsyms_directory = 'Luciq_dsym_files_fastlane'
+
+        UI.verbose 'Running Luciq Action'
+        api_token = params[:api_token]
+        eu = params[:eu] || false
+        
+        default_end_point = 'https://api.instabug.com/api/sdk/v3/symbols_files'
+        if eu
+            default_end_point = 'https://api-eu.instabug.com/api/sdk/v3/symbols_files'
+        end
+
+        endpoint = params[:end_point] || default_end_point
+        command = "curl #{endpoint} --write-out %{http_code} --silent --output /dev/null -F os=\"ios\" -F application_token=\"#{api_token}\" -F symbols_file="
+
+        dsym_paths = []
+        # Add paths provided by the user
+        dsym_paths += (params[:dsym_array_paths] || [])
+        # Add dSYMs generaed by `gym`
+        dsym_paths += [Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH]] if Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH]
+        # Add dSYMs downloaded from iTC
+        dsym_paths += Actions.lane_context[SharedValues::DSYM_PATHS] if Actions.lane_context[SharedValues::DSYM_PATHS]
+
+        dsym_paths.uniq!
+        UI.verbose 'dsym_paths: ' + dsym_paths.inspect
+
+        if dsym_paths.empty?
+          UI.error "Fastlane dSYMs file is not found! make sure you're using Fastlane action [download_dsyms] to download your dSYMs from App Store Connect"
+          return
+        end
+
+        generate_luciq_directory
+
+        UI.verbose 'Directory name: ' + @luciq_dsyms_directory
+        copy_dsym_paths_into_directory(dsym_paths, @luciq_dsyms_directory)
+
+        command = build_single_file_command(command, @luciq_dsyms_directory)
+
+        result = Actions.sh(command)
+        if result == '200'
+          UI.success 'dSYM is successfully uploaded to Luciq 🤖'
+          UI.verbose 'Removing The directory'
+        else
+          UI.error "Something went wrong during Luciq dSYM upload. Status code is #{result}"
+        end
+
+        # Cleanup zip file and directory
+        cleanup_luciq_directory
+      end
+
+      def self.description
+        "Upload dSYM files to Luciq"
+      end
+    
+      def self.details
+        "This action is used to upload symbolication files to Luciq. Incase you are not using bitcode, you can use this plug-in
+        with `gym` to upload dSYMs generated from your builds. If bitcode is enabled, you can use it with `download_dsyms` to upload dSYMs
+        from iTunes connect"
+      end
+
+      def self.authors
+        ['Luciq Inc.']
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.example_code
+        [
+          'luciq_dsym_upload(api_token: "<Luciq Token>")',
+          'luciq_dsym_upload(api_token: "<Luciq Token>", dsym_array_paths: ["./App1.dSYM.zip", "./App2.dSYM.zip"])',
+          'luciq_dsym_upload(api_token: "<Luciq Token>", eu: true)',
+          'luciq_dsym_upload(api_token: "<Luciq Token>", end_point: "https://api.instabug.com/api/sdk/v3/symbols_files")'
+        ]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: 'FL_LUCIQ_API_TOKEN', # The name of the environment variable
+                                       description: 'API Token for Luciq', # a short description of this parameter
+                                       verify_block: proc do |value|
+                                                       unless value && !value.empty?
+                                                         UI.user_error!("No API token for LuciqAction given, pass using `api_token: 'token'`")
+                                                       end
+                                                     end),
+          FastlaneCore::ConfigItem.new(key: :dsym_array_paths,
+                                       type: Array,
+                                       optional: true,
+                                       description: 'Array of paths to *.dSYM files'),
+          FastlaneCore::ConfigItem.new(key: :eu,
+                                    type: Boolean,
+                                    optional: true,
+                                    description: 'Should use the EU cluster or not'),
+          FastlaneCore::ConfigItem.new(key: :end_point,
+                                     type: String,
+                                     optional: true,
+                                     description: 'Custom end point to be used to upload the dsyms to')
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+        true
+      end
+
+      def self.generate_luciq_directory
+        cleanup_luciq_directory
+        FileUtils.mkdir_p @luciq_dsyms_directory
+      end
+
+      def self.cleanup_luciq_directory
+        FileUtils.rm_f "#{@luciq_dsyms_directory}.zip"
+        FileUtils.rm_rf @luciq_dsyms_directory
+      end
+
+      def self.remove_directory(directory_path)
+        FileUtils.rm_rf directory_path
+      end
+
+      def self.copy_dsym_paths_into_directory(dsym_paths, directory_path)
+        dsym_paths.each do |path|
+          if File.extname(path) == '.dSYM'
+            destination_path = "#{directory_path}/#{File.basename(path)}"
+            FileUtils.copy_entry(path, destination_path) if File.exist?(path)
+          else
+            Actions.sh("unzip -n #{Shellwords.shellescape(path)} -d #{Shellwords.shellescape(directory_path)}")
+          end
+        end
+      end
+
+      def self.build_single_file_command(command, dsym_path)
+        file_path = if dsym_path.end_with?('.zip')
+                      dsym_path
+                    else
+                      ZipAction.run(path: dsym_path, include: [], exclude: [])
+                    end
+        command + "@\"#{file_path}\""
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/luciq_dsym_upload/helper/luciq_dsym_upload_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class LuciqDsymUploadHelper
+      # class methods that you define here become available in your action
+      # as `Helper::LuciqDsymUploadHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the luciq_dsym_upload plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module LuciqDsymUpload
+    VERSION = "1.0.0"
+  end
+end

data/lib/fastlane/plugin/luciq_dsym_upload.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/luciq_dsym_upload/version'
+
+module Fastlane
+  module LuciqDsymUpload
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::LuciqDsymUpload.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-luciq_dsym_upload
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Luciq
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.80.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.80.0
+description:
+email: sdks@luciq.ai
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/luciq_dsym_upload.rb
+- lib/fastlane/plugin/luciq_dsym_upload/actions/luciq_dsym_upload_action.rb
+- lib/fastlane/plugin/luciq_dsym_upload/helper/luciq_dsym_upload_helper.rb
+- lib/fastlane/plugin/luciq_dsym_upload/version.rb
+homepage: https://github.com/luciqai/fastlane-plugin-luciq_dsym_upload
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Plugin to upload DSYMs to Luciq Dashboard.
+test_files: []