fastlane-plugin-create_xcframework 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b199e1658ad27bf2635c6d0be824149ac918fb1af0882fe0961a0526a62dcf17
-  data.tar.gz: '0288aba2a3501574f4c90b0b4f242f69fb53eb89fb72d97752150ea1351fe266'
+  metadata.gz: 756ad1bbb3b157ae68ea52d79c6f87ec7cf19b7bdc18c58bf77e9ac1a6323137
+  data.tar.gz: 66f51fa14b1a29986d875a4e2b46ae73430bc394e611101f2a234bd2e932d051
 SHA512:
-  metadata.gz: 9e1b1d76e028c043922a50b4151f8c2ef797a919e8646c7a3593db50e83048abd7188b16023ab3133e41296f3133b06d2f797ef132ad2b5df4ea3b0773ef7610
-  data.tar.gz: e4de2decf10795804c63b35966de57f4faa8725a7861ed473b4a145713616e3e33355344a958ba275b8e99cf8098c37306e6706df0215b34bc1cd824f9007dae
+  metadata.gz: f89281e8e0e292914480db2c0f1b910477a156bb534816e7864d5326767b24baa6d6eabeb559a2885c796f39cabc4b8ead8b8e2bdd6c9f98db1ec9a8a327839f
+  data.tar.gz: 9df35e6ccf5cbd0d0424ccec7b93a9422e5ffed4ae66b1b935a07291a4347357c183c996f9a3a0a1b53847ee61d9000d5e8853cc5e963568933446523d99fd12

data/README.md

@@ -9,10 +9,11 @@ Fastlane plugin that creates xcframework for given list of destinations 🚀
 ## Requirements
 
 * Xcode 11.x or greater. Download it at the [Apple Developer - Downloads](https://developer.apple.com/downloads) or the [Mac App Store](https://apps.apple.com/us/app/xcode/id497799835?mt=12).
+* fastlane
 
 ## Getting Started
 
-To get started with `create_xcframework`, add it to your project by running:
+To get started with `create_xcframework` plugin, add it to your project by running:
 
 ```bash
 $ fastlane add_plugin create_xcframework
@@ -22,11 +23,43 @@ $ fastlane add_plugin create_xcframework
 
 ```ruby
 create_xcframework(
-    product_name: 'Sample',
-    scheme: 'Sample',
-    workspace: 'Sample.xcworkspace',
-    include_bitcode: true,
+    workspace: 'path/to/your.xcworkspace',
+    scheme: 'framework scheme',
+    product_name: 'Sample', # optional if scheme doesnt match the name of your framework
     destinations: ['iOS', 'maccatalyst'],
-    xcframework_output_directory: 'Products/xcframeworks'
+    xcframework_output_directory: 'path/to/your/output dir'
 )
 ```
+
+Run
+```bash
+$ fastlane actions create_xcframework
+```
+to learn more about the plugin.
+
+### Supported destinations
+
+* iOS
+* iPadOS
+* maccatalyst
+* tvOS
+* watchOS
+* carPlayOS
+* macOS
+
+## Output
+
+#### Files:
+* xcframework
+* dSYMs dir
+* BCSymbolMaps dir (if bitcode is enabled)
+
+#### Env vars:
+* XCFRAMEWORK_OUTPUT_PATH
+* XCFRAMEWORK_DSYM_OUTPUT_PATH
+* XCFRAMEWORK_BCSYMBOLMAPS_OUTPUT_PATH
+
+
+## Contribution
+
+- If you **want to contribute**, read the [Contributing Guide](https://github.com/bielikb/fastlane-plugin-create_xcframework/blob/master/CONTRIBUTING.md)

data/lib/fastlane/plugin/create_xcframework/actions/create_xcframework_action.rb

@@ -25,7 +25,7 @@ module Fastlane
             XcarchiveAction.run(params)
           end
 
-          create_xcframework
+          create_xcframework(params)
 
           copy_dSYMs(params)
 
@@ -52,17 +52,41 @@ module Fastlane
         @xchelper.xcarchive_frameworks_path.each { |framework| FileUtils.rm_rf(framework.split('/').first) }
       end
 
-      def self.create_xcframework
+      def self.create_xcframework(params)
         xcframework = @xchelper.xcframework_path
         begin
           FileUtils.rm_rf(xcframework) if File.exist?(xcframework)
-          framework_links = @xchelper.xcarchive_frameworks_path.map { |path| "-framework #{path}" }.join(' ')
-          Actions.sh("set -o pipefail && xcodebuild -create-xcframework #{framework_links} -output #{xcframework}")
+          framework_links = params[:destinations].each_with_index.map do |_, index| 
+            "-framework #{@xchelper.xcarchive_framework_path(index)} #{debug_symbols(index: index, params: params)}"
+          end
+
+          Actions.sh("set -o pipefail && xcodebuild -create-xcframework #{framework_links.join(' ')} -output #{xcframework}")
         rescue => err
           UI.user_error!(err)
         end
       end
 
+      def self.debug_symbols(index:, params:)
+        return "" unless Helper.xcode_at_least?('12.0.0')
+
+        debug_symbols = []
+
+        # Include dSYMs in xcframework
+        if params[:include_dSYMs] != false
+          debug_symbols << "-debug-symbols #{@xchelper.xcarchive_dSYMs_path(index)}/#{@xchelper.framework}.dSYM"
+        end
+
+        # Include BCSymbols in xcframework
+        if params[:include_BCSymbolMaps] != false && params[:include_bitcode] != false
+          bc_symbols_dir = @xchelper.xcarchive_BCSymbolMaps_path(index)
+          if Dir.exist?(bc_symbols_dir) 
+            debug_symbols << Dir.children(bc_symbols_dir).map { |path| "-debug-symbols #{File.expand_path("#{bc_symbols_dir}/#{path}")}" }.join(' ') 
+          end
+        end
+
+        debug_symbols.join(' ')
+      end
+
       def self.copy_dSYMs(params)
         dSYMs_output_dir = @xchelper.xcframework_dSYMs_path
         FileUtils.mkdir_p(dSYMs_output_dir)
@@ -79,7 +103,7 @@ module Fastlane
       end
 
       def self.copy_BCSymbolMaps(params)
-        return unless params[:include_bitcode]
+        return if params[:include_bitcode] == false
 
         symbols_output_dir = @xchelper.xcframework_BCSymbolMaps_path
         FileUtils.mkdir_p(symbols_output_dir)
@@ -109,7 +133,7 @@ module Fastlane
         end
         xcargs = ['SKIP_INSTALL=NO', 'BUILD_LIBRARY_FOR_DISTRIBUTION=YES']
 
-        if params[:include_bitcode]
+        if params[:include_bitcode] != false
           params[:xcargs].gsub!(/ENABLE_BITCODE(=|\s+)(YES|NO)/, '') if params[:xcargs]
           xcargs << ['OTHER_CFLAGS="-fembed-bitcode"', 'BITCODE_GENERATION_MODE="bitcode"', 'ENABLE_BITCODE=YES']
         end
@@ -153,7 +177,6 @@ module Fastlane
           create_xcframework(
             workspace: 'path/to/your.xcworkspace',
             scheme: 'framework scheme',
-            include_bitcode: true,
             destinations: ['iOS'],
             xcframework_output_directory: 'output_directory'
           )
@@ -173,7 +196,7 @@ module Fastlane
       end
 
       def self.details
-        "Create xcframework plugin generates xcframework for specified destinations. The output of this action consists of the xcframework itself, dSYM and BCSymbolMaps, if bitcode is enabled."
+        "Create xcframework plugin generates xcframework for specified destinations. The output of this action consists of the xcframework itself, which contains dSYM and BCSymbolMaps, if bitcode is enabled."
       end
 
       def self.available_options
@@ -185,10 +208,10 @@ module Fastlane
           ),
           FastlaneCore::ConfigItem.new(
             key: :include_bitcode,
-            description: "Should the xcframework include bitcode?",
+            description: "Should the project be built with bitcode enabled?",
             optional: true,
             is_string: false,
-            default_value: false
+            default_value: true
           ),
           FastlaneCore::ConfigItem.new(
             key: :destinations,
@@ -202,6 +225,18 @@ module Fastlane
             description: "The directory in which the xcframework should be stored in",
             optional: true
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :include_dSYMs,
+            description: "Includes dSYM files in the xcframework",
+            optional: true,
+            default_value: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :include_BCSymbolMaps,
+            description: "Includes BCSymbolMap files in the xcframework",
+            optional: true,
+            default_value: true
+          ),
           FastlaneCore::ConfigItem.new(
             key: :product_name,
             description: "The name of your module. Optional if equals to :scheme. Equivalent to CFBundleName",

data/lib/fastlane/plugin/create_xcframework/helper/create_xcframework_helper.rb

@@ -33,23 +33,23 @@ module Fastlane
       end
 
       def xcarchive_dSYMs_path(framework_index)
-        "#{xcarchive_path(framework_index)}/dSYMS"
+        File.expand_path("#{xcarchive_path(framework_index)}/dSYMS")
       end
 
       def xcframework_dSYMs_path
-        "#{output_directory}/#{product_name}.dSYMs"
+        File.expand_path("#{output_directory}/#{product_name}.dSYMs")
       end
 
       def xcarchive_BCSymbolMaps_path(framework_index)
-        "#{xcarchive_path(framework_index)}/BCSymbolMaps"
+        File.expand_path("#{xcarchive_path(framework_index)}/BCSymbolMaps")
       end
 
       def xcframework_BCSymbolMaps_path
-        "#{output_directory}/#{product_name}.BCSymbolMaps"
+        File.expand_path("#{output_directory}/#{product_name}.BCSymbolMaps")
       end
 
       def xcframework_path
-        "#{output_directory}/#{xcframework}"
+        File.expand_path("#{output_directory}/#{xcframework}")
       end
 
       def output_directory

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

@@ -1,5 +1,5 @@
 module Fastlane
   module CreateXcframework
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-create_xcframework
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Boris Bielik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Fastlane plugin that creates xcframework for given list of destinations.