fastlane-plugin-unity_exporter 1.0.4 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96e50a14af9081a9995f926e20603a15aeeebbdb167c3a7488488e074f9095b4
-  data.tar.gz: 3f894f28a17b8addad168696daf246e408ed00ba6e2164f4a9c742a97b114ec2
+  metadata.gz: 3054d1e2b69c1d5c8d9d036f18339e0fbdcd1d9c232e40bf1986ac96c1ce8fde
+  data.tar.gz: aa1e6ab7b87c527ccba402bce4029e9dc0a1609bbb5bc587e6e9783e5e2f2192
 SHA512:
-  metadata.gz: 69f08ae45b2538b88c47fe4c2b01bf78312b2fc952414a21e5a733c1da4d41e459f3b3a0db9e184c4b1c56217ff44d917864c2ff9a4d78586b1488c80926fdf8
-  data.tar.gz: 1629f955e2b634eceff64074e821d3c93336e92d79b3d14ddc6681fdb4ea51ce08b7961a388122174b00ff8a8a63249588e960c7b0ab66032e32cc745964aedb
+  metadata.gz: 706fd9e68d728df14014d9d30e6bd88816a71f026ef6c852c075b0f6335c7e821644259d9ea30ea046aea8798aef2a731230846c659f3ff7d15c83601389f64c
+  data.tar.gz: f638422b8d2fb7261a586d8f99ca84f79baa6b773d993c7e1a5f46feca5a988665cd14274b8ebfc4bca58035331f994ed14645e0c419ab4b73f32d51e2cd00af

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`
@@ -107,6 +115,46 @@ 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`
+
+```ruby
+# you must first use the unity export action
+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`
+
+```ruby
+# you must first use the unity export action
+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,18 +1,23 @@
 require 'fastlane/action'
 require_relative '../helper/unity_editor_helper'
+require_relative '../helper/generic_helper'
 
 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
 
-        log_file = "unity-export-logs/#{DateTime.now.strftime('%Y-%m-%d_%H-%M-%S-%L')}_git.log"
+        log_file = Helper::GenericHelper.instance_variable_get(:@git_log_path)
 
         # 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
 
@@ -33,6 +38,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

@@ -17,11 +17,15 @@ module Fastlane
           end
 
         elsif params[:build_target]
+          if params[:project_path]
+            Helper::UnityEditorHelper.instance_variable_set(:@project_path, 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/actions/unity_get_build_number.rb

@@ -0,0 +1,56 @@
+require 'fastlane/action'
+require_relative '../helper/unity_editor_helper'
+require_relative '../helper/build_exporter_helper'
+
+module Fastlane
+  module Actions
+    class UnityGetBuildNumberAction < Action
+      def self.run(params)
+        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
+
+        return build_number
+      end
+
+      def self.description
+        "Will get the build number that was used for the latest Unity export action. Therefore make sure to call the Unity export action before you use this action."
+      end
+
+      def self.authors
+        ["steft"]
+      end
+
+      def self.return_value
+        "Returns the build number that was used for the latest Unity export action. In case of error will return 'unity_exporter_error_occurred'."
+      end
+
+      def self.details
+        # Optional:
+      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)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        [:ios, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+require 'fastlane/action'
+require_relative '../helper/unity_editor_helper'
+require_relative '../helper/build_exporter_helper'
+
+module Fastlane
+  module Actions
+    class UnityGetVersionNumberAction < Action
+      def self.run(params)
+        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
+
+        return version_number
+      end
+
+      def self.description
+        "Will get the version number that was used for the latest Unity export action. Therefore make sure to call the Unity export action before you use this action."
+      end
+
+      def self.authors
+        ["steft"]
+      end
+
+      def self.return_value
+        "Returns the version number that was used for the latest Unity export action. In case of error will return 'unity_exporter_error_occurred'."
+      end
+
+      def self.details
+        # Optional:
+      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)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        [:ios, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -2,10 +2,12 @@ require 'fastlane_core/ui/ui'
 require 'shellwords'
 
 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.shellify(path)
         if FastlaneCore::Helper.is_mac?
           return Shellwords.escape(path)

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

@@ -4,14 +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
-      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("../../")
-        return "../../"
+      # project path relative if following hierarchy is given: "root/{unity-project}/fastlane-build-exporter/{platform}-export/."
+      # p File.expand_path("../../")
+      @project_path_default = "../../"
+      @project_path = ""
+
+      def self.unity_project_path
+        project_path = @project_path == "" ? "../../" : @project_path
+
+        # 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
@@ -46,6 +57,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 +69,18 @@ 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
+        return File.read(package_manifest_path)
       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

@@ -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
@@ -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.3.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-unity_exporter
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.3.1
 platform: ruby
 authors:
 - ar:met
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -161,6 +161,9 @@ files:
 - lib/fastlane/plugin/unity_exporter.rb
 - lib/fastlane/plugin/unity_exporter/actions/unity_commit_version_bump.rb
 - 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