fastlane-plugin-unity_exporter 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96e50a14af9081a9995f926e20603a15aeeebbdb167c3a7488488e074f9095b4
-  data.tar.gz: 3f894f28a17b8addad168696daf246e408ed00ba6e2164f4a9c742a97b114ec2
+  metadata.gz: 7bff3d2d963ce751f8770a2e461b1765637ef1a4d7a274ff48b9de6be392f0e3
+  data.tar.gz: d57e0104dd2d54504d384681ad84d6f39a811c7e5e321e2eecad2421e9718a1f
 SHA512:
-  metadata.gz: 69f08ae45b2538b88c47fe4c2b01bf78312b2fc952414a21e5a733c1da4d41e459f3b3a0db9e184c4b1c56217ff44d917864c2ff9a4d78586b1488c80926fdf8
-  data.tar.gz: 1629f955e2b634eceff64074e821d3c93336e92d79b3d14ddc6681fdb4ea51ce08b7961a388122174b00ff8a8a63249588e960c7b0ab66032e32cc745964aedb
+  metadata.gz: 4f02ef24f177fd4885bf28b2d6c1470ced2ec9ef45c00c9105001a1962053f3a67403991a9e029e85d53064dba5ae5e091e7731098945bd14a008b3c8f3e0300
+  data.tar.gz: 31b2a74cf72c8c38a4c9272984ac9104600b063982eebaf66b40a409ab46a8c257560f6176d19b7b9fae97eea76a2dfa74bb9c7cf016fcd1e7af6533cc5adea3

data/README.md

@@ -88,13 +88,21 @@ unity_export(build_target: "...", new_version_code: "42")
 # increments the existing version code (Android) and build number (iOS)
 unity_export(build_target: "...", new_version_code: "increment")
 
+# the expected default path is in accordance with the "getting started" section of this readme
+# if a custom path to the Unity project is required, it's specified this way
+# note that the starting point for relative paths is the directory that contains the 'fastlane' folder
+unity_export(build_target: "...", project_path: "path/some-example-unity-projects-directory")
+
 # exports the Unity project to the specified path
 # if no export path is specified, a default path will be used
 # note that the starting point for relative paths is the root of the Unity project
 unity_export(build_target: "...", export_path: "path/some-example-builds-directory")
 
-# combined usage of 'new_version' and 'new_version_code' and 'export_path'
-unity_export(build_target: "...", new_version: "2.3.4", new_version_code: "0", export_path: "path/Builds")
+# combined usage of 'new_version', 'new_version_code', 'project_path' and 'export_path'
+unity_export(
+  build_target: "...", 
+  new_version: "2.3.4", new_version_code: "0", 
+  project_path: "path/Unity-project", export_path: "path/Builds")
 ```
 
 ### Using `unity_commit_version_bump`

data/lib/fastlane/plugin/unity_exporter/actions/unity_commit_version_bump.rb

@@ -12,7 +12,7 @@ module Fastlane
 
         # Thank you: https://linuxize.com/post/bash-redirect-stderr-stdout/#redirecting-stderr-to-stdout
         sh("echo 'UnityCommitVersionBumpAction: created file' > #{log_file} 2>&1")
-        sh("git add '#{Helper::UnityEditorHelper.unity_project_path_relative_to_fastfile}ProjectSettings/ProjectSettings.asset' >> #{log_file} 2>&1")
+        sh("git add '#{Helper::UnityEditorHelper.unity_project_path}ProjectSettings/ProjectSettings.asset' >> #{log_file} 2>&1")
         sh("git commit -m 'Version Bump' >> #{log_file} 2>&1")
       end
 

data/lib/fastlane/plugin/unity_exporter/actions/unity_export.rb

@@ -17,11 +17,15 @@ module Fastlane
           end
 
         elsif params[:build_target]
+          if params[:project_path]
+            Helper::UnityEditorHelper.class_variable_set(:@@projectPath, params[:project_path])
+          end
+
           # following are arguments as defined in the docs: https://docs.unity3d.com/Manual/CommandLineArguments.html
           headless_args = "-buildTarget #{params[:build_target]}"
           headless_args << " -batchmode -nographics -quit" # some arguments that are required when running Unity in headless-mode
           headless_args << " -accept-apiupdate -releaseCodeOptimization"
-          headless_args << " -projectPath #{Helper::UnityEditorHelper.unity_project_path_relative_to_fastfile}"
+          headless_args << " -projectPath #{Helper::UnityEditorHelper.unity_project_path}"
           headless_args << " -logFile unity-export-logs/#{DateTime.now.strftime('%Y-%m-%d_%H-%M-%S-%L')}_#{params[:build_target]}_build.log" # logging; not specifying a path will print the log to the console
 
           # following are custom arguments defined in 'UnityExporter.BuildUtility'
@@ -67,7 +71,7 @@ module Fastlane
           return
         end
 
-        UI.message("Open 'logFile', if you want to know whats going on with your build.")
+        UI.message("Open 'logFile', if you want to know whats going on with your build. Look for its path in the invocation of the next line.")
         invocation = unity_path.to_s
         invocation << " #{params[:arguments]}"
         sh(invocation) # 'sh' will print what's passed to it
@@ -166,6 +170,13 @@ module Fastlane
                                          end
                                        end),
 
+          FastlaneCore::ConfigItem.new(key: :project_path,
+                                       env_name: "FL_UNITY_PROJECT_PATH",
+                                       description: "The path to the Unity project. The starting point for relative paths is the directory that contains the 'fastlane' folder",
+                                       optional: true,
+                                       type: String,
+                                       conflicting_options: [:arguments]),
+
           FastlaneCore::ConfigItem.new(key: :export_path,
                                        env_name: "FL_UNITY_EXPORT_PATH",
                                        description: "The path to the exported Unity project. The starting point for relative paths is the root of the Unity project",

data/lib/fastlane/plugin/unity_exporter/helper/unity_editor_helper.rb

@@ -8,9 +8,13 @@ module Fastlane
 
   module Helper
     class UnityEditorHelper
-      def self.unity_project_path_relative_to_fastfile
-        # project path relative if following hierarchy is given: "root/{unity-project}/fastlane-build-exporter/{platform}-export/."
-        # p File.expand_path("../../")
+      # project path relative if following hierarchy is given: "root/{unity-project}/fastlane-build-exporter/{platform}-export/."
+      # p File.expand_path("../../")
+      @@projectPathDefault = "../../"
+      @@projectPath = ""
+
+      def self.unity_project_path
+        return @@projectPath if @@projectPath != ""
         return "../../"
       end
 
@@ -46,6 +50,7 @@ module Fastlane
         # TODO Unity currently does not support commandline arguments for the Package Manager
         exporter_package_namespace = "io.armet.unity.buildexporter"
         included = load_unity_project_package_manifest.include?(exporter_package_namespace)
+        # UI.message("exporter package part of Unity project: '#{included}'")
         unless included
           UI.user_error!("Package 'io.armet.unity.exporter' must be added to the Unity project.")
         end
@@ -57,19 +62,25 @@ module Fastlane
         relative_path = if FastlaneCore::Helper.is_test?
                           "/tmp/fastlane/tests/fixtures/unity_project"
                         else
-                          unity_project_path_relative_to_fastfile
+                          unity_project_path
                         end
 
         package_manifest_path = "#{relative_path}/Packages/manifest.json"
-        package_manifest_json = File.read(package_manifest_path)
-        return package_manifest_json
+
+        # we verify the path to the Unity project by looking for the 'manifest.json' file
+        if File.file?(package_manifest_path)
+          return File.read(package_manifest_path)
+        else
+          UI.user_error!("Cannot find 'manifest.json' at '#{package_manifest_path}'. Make sure that the Unity project path is properly set.")
+          return ""
+        end
       end
 
       def self.load_unity_project_version
         relative_path = if FastlaneCore::Helper.is_test?
                           "/tmp/fastlane/tests/fixtures/unity_project"
                         else
-                          unity_project_path_relative_to_fastfile
+                          unity_project_path
                         end
 
         project_version_txt_path = "#{relative_path}/ProjectSettings/ProjectVersion.txt"

data/lib/fastlane/plugin/unity_exporter/helper/unity_hub_helper.rb

@@ -28,7 +28,7 @@ module Fastlane
 
       def self.verify_default_path
         # verifies that the Unity Hub exists at the default path
-        exists = File.file?(Helper::UnityHubHelper.unity_hub_path(false)) == true
+        exists = File.file?(Helper::UnityHubHelper.unity_hub_path(false))
         unless exists
           UI.error("Unity Hub does not exist at path '#{Helper::UnityHubHelper.unity_hub_path(false)}'")
         end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module UnityExporter
-    VERSION = "1.0.4"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-unity_exporter
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - ar:met