fastlane-plugin-unity_exporter 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f871c4202b1c52b9d5d719312834f66f9374a6a16319925a6e39d5d3f87f258
-  data.tar.gz: 6c74a627ee70148c1b27d52421f5bf275d5ce2405c60588db6abeee04dcded2e
+  metadata.gz: cad649f6ebbc0102d8e2d8295a76350b09b4fbd9873d2581ac65971b6a156ac5
+  data.tar.gz: e043af9dd9db9a8372866e822487bb47d82363937bd9d6d9d263798ca50c090e
 SHA512:
-  metadata.gz: e62253ae48ffaa41ee6a62ce09e91b0d10dcc610e05216ddec73414ea2f1d295263c95117289fd9ca33c0622036f98e9e7d44cddb3fedf360e4245378a569aa9
-  data.tar.gz: 3ce7dc870812337f11e80c9de94910697b47278dc98b31d51dbffe7b5006516bbb7b07342693269ee624d818000a931c4d31c9e4fecb4d4a9e63d6ae8e916482
+  metadata.gz: de4f1d457398aa20fd87cb4dabe052cad7819a5c12e54d968f3b7b79c18235f93d2f1bbf5e2e211282867c2fbe38106770bd387d8ac70f2a26c38601e3490880
+  data.tar.gz: 2f510f3242214de7440bea574cfc367a6bfbeaec6fd3ebebf0db5c43eee185526517f0e473a67204ece53015e84ef9219f562ac5bf8c00917db1f105fd3c9ba7

data/README.md

@@ -115,6 +115,12 @@ unity_export(build_target: "...", new_version: "3.4.5", new_version_code: "0")
 
 # after the export is finished, we commit the version bump
 unity_commit_version_bump
+
+# another invocation example that specifies a project path
+# 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_commit_version_bump(project_path: "path/some-example-unity-projects-directory")
 ```
 
 ### Using `unity_get_version_number`
@@ -126,6 +132,12 @@ unity_export(...)
 # afterwards you can get the version number like so
 # note that an error code will be returned if something fails
 version_number = unity_get_version_number
+
+# another invocation example that specifies a project path
+# 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
+version_number = unity_get_version_number(project_path: "path/some-example-unity-projects-directory")
 ```
 
 ### Using `unity_get_build_number`
@@ -137,6 +149,12 @@ unity_export(...)
 # afterwards you can get the build number like so
 # note that an error code will be returned if something fails
 build_number = unity_get_build_number
+
+# another invocation example that specifies a project path
+# 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
+build_number = unity_get_build_number(project_path: "path/some-example-unity-projects-directory")
 ```
 
 

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

@@ -1,4 +1,5 @@
 require 'fastlane/action'
+require 'fastlane_core/configuration/config_item'
 require_relative '../helper/unity_editor_helper'
 require_relative '../helper/generic_helper'
 
@@ -6,6 +7,10 @@ module Fastlane
   module Actions
     class UnityCommitVersionBumpAction < Action
       def self.run(params)
+        if params[:project_path]
+          Helper::UnityEditorHelper.instance_variable_set(:@project_path, params[:project_path])
+        end
+
         # TODO: improve the commit command: currently it simply commits the ProjectSettings file
         #      what if there are other changes in the file and you don't want these changes to be part of the commit
 
@@ -34,6 +39,14 @@ module Fastlane
       end
 
       def self.available_options
+        [
+          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])
+        ]
       end
 
       def self.is_supported?(platform)

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

@@ -26,7 +26,7 @@ module Fastlane
           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}"
-          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
+          headless_args << " -logFile #{Helper::UnityEditorHelper.unity_project_path}/BuildExporter/#{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'
           # this script is part of the 'fastlane-plugin-unity-exporter-package'

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

@@ -1,12 +1,17 @@
 require 'fastlane/action'
+require 'fastlane_core/configuration/config_item'
 require_relative '../helper/unity_editor_helper'
-require_relative '../helper/generic_helper'
+require_relative '../helper/build_exporter_helper'
 
 module Fastlane
   module Actions
     class UnityGetBuildNumberAction < Action
       def self.run(params)
-        build_number = Helper::GenericHelper.build_exporter_build_number
+        if params[:project_path]
+          Helper::UnityEditorHelper.instance_variable_set(:@project_path, params[:project_path])
+        end
+
+        build_number = Helper::BuildExporterHelper.build_number
         if build_number == ""
           return "unity_exporter_error_occurred"
         end
@@ -31,6 +36,14 @@ module Fastlane
       end
 
       def self.available_options
+        [
+          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])
+        ]
       end
 
       def self.is_supported?(platform)

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

@@ -1,12 +1,17 @@
 require 'fastlane/action'
+require 'fastlane_core/configuration/config_item'
 require_relative '../helper/unity_editor_helper'
-require_relative '../helper/generic_helper'
+require_relative '../helper/build_exporter_helper'
 
 module Fastlane
   module Actions
     class UnityGetVersionNumberAction < Action
       def self.run(params)
-        version_number = Helper::GenericHelper.build_exporter_version_number
+        if params[:project_path]
+          Helper::UnityEditorHelper.instance_variable_set(:@project_path, params[:project_path])
+        end
+
+        version_number = Helper::BuildExporterHelper.version_number
         if version_number == ""
           return "unity_exporter_error_occurred"
         end
@@ -31,6 +36,14 @@ module Fastlane
       end
 
       def self.available_options
+        [
+          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])
+        ]
       end
 
       def self.is_supported?(platform)

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

@@ -0,0 +1,44 @@
+require 'fastlane_core/ui/ui'
+require 'shellwords'
+require_relative './unity_editor_helper'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    # a helper class specific to the Unity-Build-Exporter package: https://github.com/ar-met/unity-build-exporter
+    class BuildExporterHelper
+      def self.versions_file_content
+        # this is created and updated whenever you create a build via the build exporter
+        build_exporter_versions_file = "#{Helper::UnityEditorHelper.unity_project_path}/BuildExporter/latest-build-version.txt"
+
+        if File.file?(build_exporter_versions_file)
+          return File.readlines(build_exporter_versions_file, chomp: true)
+        else
+          UI.user_error!("Versions file does not exist yet. You must execute the Unity export action beforehand.")
+          return []
+        end
+      end
+
+      def self.version_number
+        versions = versions_file_content
+
+        if versions.count > 0
+          return versions[0]
+        else
+          return ""
+        end
+      end
+
+      def self.build_number
+        versions = versions_file_content
+
+        if versions.count > 0
+          return versions[1]
+        else
+          return ""
+        end
+      end
+    end
+  end
+end

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

@@ -1,46 +1,13 @@
 require 'fastlane_core/ui/ui'
 require 'shellwords'
-require_relative './unity_editor_helper'
 
 module Fastlane
-  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
 
   module Helper
     class GenericHelper
       @git_log_path = "fastlane-unity-exporter/logs/#{DateTime.now.strftime('%Y-%m-%d_%H-%M-%S-%L')}_git.log"
 
-      def self.build_exporter_versions
-        # this is created and updated whenever you create a build via the build exporter
-        build_exporter_versions_file = "#{Helper::UnityEditorHelper.unity_project_path}/BuildExporter/latest-build-version.txt"
-
-        if File.file?(build_exporter_versions_file)
-          return File.readlines(build_exporter_versions_file, chomp: true)
-        else
-          UI.user_error!("Versions file does not exist yet. You must execute the Unity export action beforehand.")
-          return []
-        end
-      end
-
-      def self.build_exporter_version_number
-        versions = build_exporter_versions
-
-        if versions.count > 0
-          return versions[0]
-        else
-          return ""
-        end
-      end
-
-      def self.build_exporter_build_number
-        versions = build_exporter_versions
-
-        if versions.count > 0
-          return versions[1]
-        else
-          return ""
-        end
-      end
-
       def self.shellify(path)
         if FastlaneCore::Helper.is_mac?
           return Shellwords.escape(path)

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

@@ -4,19 +4,25 @@ require_relative './unity_hub_helper'
 require_relative './generic_helper'
 
 module Fastlane
-  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
 
   module Helper
     class UnityEditorHelper
       # project path relative if following hierarchy is given: "root/{unity-project}/fastlane-build-exporter/{platform}-export/."
-      # p File.expand_path("../../")
-      @project_path_default = "../../"
+      # p File.expand_path("../..")
+      @project_path_default = "../.."
       @project_path = ""
 
       def self.unity_project_path
-        return @project_path if @project_path != ""
+        project_path = @project_path == "" ? @project_path_default : @project_path
 
-        return "../../"
+        # we verify the path to the Unity project by looking for the 'manifest.json' file
+        package_manifest_path = "#{project_path}/Packages/manifest.json"
+        unless File.file?(package_manifest_path)
+          UI.user_error!("Cannot find 'manifest.json' at '#{package_manifest_path}'. Make sure that the Unity project path is properly set.")
+        end
+
+        return project_path
       end
 
       def self.unity_editor_path
@@ -67,14 +73,7 @@ module Fastlane
                         end
 
         package_manifest_path = "#{relative_path}/Packages/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
+        return File.read(package_manifest_path)
       end
 
       def self.load_unity_project_version

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

@@ -2,7 +2,7 @@ require 'fastlane_core/ui/ui'
 require_relative './generic_helper'
 
 module Fastlane
-  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
 
   module Helper
     class UnityHubHelper

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

@@ -1,5 +1,5 @@
 module Fastlane
   module UnityExporter
-    VERSION = "1.2.0"
+    VERSION = "1.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-unity_exporter
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - ar:met
@@ -163,6 +163,7 @@ files:
 - lib/fastlane/plugin/unity_exporter/actions/unity_export.rb
 - lib/fastlane/plugin/unity_exporter/actions/unity_get_build_number.rb
 - lib/fastlane/plugin/unity_exporter/actions/unity_get_version_number.rb
+- lib/fastlane/plugin/unity_exporter/helper/build_exporter_helper.rb
 - lib/fastlane/plugin/unity_exporter/helper/generic_helper.rb
 - lib/fastlane/plugin/unity_exporter/helper/unity_editor_helper.rb
 - lib/fastlane/plugin/unity_exporter/helper/unity_hub_helper.rb