fastlane-plugin-unity_exporter 1.0.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99aaaf9abdb2e6fa743ffb0817d6631f18d9ce657802aeac72e33aed6ad3be60
-  data.tar.gz: 613bd80e538855cce80c4e80e5accb65747398eef2fb2efe8b0fe63133372b99
+  metadata.gz: 1a1b16db5c56d81b08d0c944ddfde6d5e3295d714ec07cb0ed0155faa663ea21
+  data.tar.gz: f84cc70bd9024acd8df427efad57d3dbd1c58e8855fd35eed5a60643651cf10e
 SHA512:
-  metadata.gz: e22a576504bde4153f303377b0e8c5ebe5ef5000e8f30d856bf07816919a8d099219d5fdda79680940d7ae97148156c40322662b52c56a402639e1115f0904c7
-  data.tar.gz: 39760c4e0b721e407deccd8056ea3c0a4542ba21a93f69f209224452d868469e35afafe881c85c37045f6b3aadc9f3bdb57027ee32075cd186ba13fc844bab44
+  metadata.gz: e126535a70b41d1a67d8d6939c7d426fcac0e5138c96d9ba13f902899ab6e02f3f4bad882e8f98b5df651fa76fa4b9a90a5ca0a30ff60978fa059b248ef5f401
+  data.tar.gz: 365a6cd6106ca841fc0e59baa8ca837fa3c8c3ba1bd096453950ce3895b2b23a47fe324c8182ab247d2ae66f19c90b924b9dc57326a47c1cdd3bbaceda235ff4

data/README.md

@@ -88,8 +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")
 
-# combined usage of 'new_version' and 'new_version_code'
-unity_export(build_target: "...", new_version: "2.3.4", new_version_code: "0")
+# 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', '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`
@@ -102,12 +115,47 @@ 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`
 
-## Compatibility
+```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")
+```
 
-Both this _fastlane plugin_ and the [_Unity Build Exporter_](https://github.com/ar-met/unity-build-exporter) were developed with _Unity 2020.3.13f1_. We haven't tested the plugin with any earlier versions, but we don't expect there to be any issues. If you run into trouble, regarding compatibility or anything else, [please open an issue](https://github.com/ar-met/unity-build-exporter/issues). For pull requests [see here](#pull-requests).
+### 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")
+```
 
 
 ## Example
@@ -117,6 +165,24 @@ Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plu
 Also check out the example [_Unity3d_ project](https://github.com/ar-met/fastlane-plugin-unity-exporter-example-project) to see how this plugin works. See the repositories readme for more details.
 
 
+## Compatibility
+
+Both this _fastlane plugin_ and the [_Unity Build Exporter_](https://github.com/ar-met/unity-build-exporter) were developed with _Unity 2020.3.13f1_. We haven't tested the plugin with any earlier versions, but we don't expect there to be any issues. If you run into trouble, regarding compatibility or anything else, [please open an issue](https://github.com/ar-met/unity-build-exporter/issues). For pull requests [see here](#pull-requests).
+
+
+## Ruby
+
+Note that this plugin requires `Ruby 2.7.4`. 
+
+### Ruby on Mac
+
+Installing ruby -- even different versions of it -- on Mac and _fastlane_ is well documented.
+
+### Ruby on Windows
+
+To install ruby on Windows you, e.g., can use [_RubyInstaller_](https://rubyinstaller.org/downloads/). Be sure to get `Ruby 2.7.4`. After that you can use `gem` commands with Windows' command prompt and rely on _fastlane_'s documentation to get you going.
+
+
 ## Pull requests
 
 We are happy to accept [pull requests](https://github.com/ar-met/unity-build-exporter/pulls). For easier development of this plugin, we suggest you use the provided [_Unity3d_ project](https://github.com/ar-met/fastlane-plugin-unity-exporter-dev-project).

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'
@@ -29,7 +33,12 @@ module Fastlane
           headless_args << " -executeMethod armet.BuildExporter.BuildUtility.CreateBuild"
           headless_args << " -newVersion #{params[:new_version]}" if params[:new_version]
           headless_args << " -newVersionCode #{params[:new_version_code]}" if params[:new_version_code]
-          headless_args << " -exportPath fastlane-build-exporter/#{params[:build_target]}/unity-export"
+
+          if params[:export_path]
+            headless_args << " -exportPath #{params[:export_path]}"
+          else
+            headless_args << " -exportPath fastlane-build-exporter/#{params[:build_target]}/unity-export"
+          end
 
           # NOTE: the different relative paths used in 'projectPath' and 'exportPath'
           # while 'projectPath' is relative to the 'fastfile',
@@ -62,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
@@ -159,7 +168,21 @@ module Fastlane
                                              UI.user_error!("Please pass a valid version code. For options see 'fastlane action unity_exporter'")
                                            end
                                          end
-                                       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",
+                                       optional: true,
+                                       type: String,
+                                       conflicting_options: [:arguments])
         ]
       end
 

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

@@ -6,6 +6,8 @@ module Fastlane
 
   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

@@ -8,10 +8,21 @@ 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("../../")
-        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

@@ -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.3"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-unity_exporter
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.3.0
 platform: ruby
 authors:
 - ar:met
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-27 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