fastlane-plugin-yalantis_ci 0.2.6 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ba1e6dc0a29a4250e05364a8b7f00cd51738e062f829aa71d99496b6e2bee8b
-  data.tar.gz: d6a6be86add42155e6b9d1cb833250b79b123159003073c0354390baed66e462
+  metadata.gz: 4622dd6d9a13b4d67310b8cd8421bc00abcba72ddaa43ccc0765527f3d647699
+  data.tar.gz: 989f4db2393f9a5cd2401522b69a04f439d6f07f75fea35b29554887dff25b31
 SHA512:
-  metadata.gz: 67f65a3e164ed66b62569b0874ad2c14c0b6b6d955c2fc32bccd4b8295e38309acdb24279032e1e687d044929de9dd1f3dd6674b528a07c0d271e7d26b3bc33e
-  data.tar.gz: 22f3cdbff0c34efc462b7fa895aac4fa0f435234220ce139af46a5dc06e877ffc6b57a9004b0e95718f9a204781200a0bc4e44fdcc56798e115ad6b94ca76de7
+  metadata.gz: 2b0155b2f1ec999d5a2de687a0d9ad705865fe1333ece391dfd09d82fb78d3a21c7cb3b333c6f70911e523e7dc67ba721768d209ae05a50acbfa611d02b2e89f
+  data.tar.gz: cd2d555a42cfa1333b2ace48234e598cf4c705853a7550481df2b72e9515320140f586a801b7d508f4e448cc359882ac2e2042a158733de7cff01b102f18d78d

data/lib/fastlane/plugin/yalantis_ci/actions/app_store_connect_api_key_add_to_remote.rb

@@ -17,7 +17,7 @@ module Fastlane
           UI.user_error!(":key_content or :key_filepath is required")
         end
 
-        Helper::GitHelper.clone_repo_in_tmp(git_repo_url, git_repo_branch, true) do |dir|
+        Helper::GitHelper.clone_repo_in_tmp(repo_url: git_repo_url, branch: git_repo_branch, create_branch: true) do |dir|
           target_filename = "#{key_id}.p8"
           target_filepath = File.join(dir, target_filename)
 

data/lib/fastlane/plugin/yalantis_ci/actions/app_store_connect_api_key_remove_from_remote.rb

@@ -10,7 +10,7 @@ module Fastlane
         git_repo_branch = options[:git_repo_branch]
         key_id = options[:key_id]
 
-        Helper::GitHelper.clone_repo_in_tmp(git_repo_url, git_repo_branch, false) do |dir|
+        Helper::GitHelper.clone_repo_in_tmp(repo_url: git_repo_url, branch: git_repo_branch) do |dir|
           target_filename = "#{key_id}.p8"
           target_filepath = File.join(dir, target_filename)
 

data/lib/fastlane/plugin/yalantis_ci/actions/app_store_connect_api_key_set_from_remote.rb

@@ -12,7 +12,7 @@ module Fastlane
         issuer_id = options[:issuer_id]
         in_house = options[:in_house]
         
-        Helper::GitHelper.clone_repo_in_tmp(git_repo_url, git_repo_branch) do |dir|
+        Helper::GitHelper.clone_repo_in_tmp(repo_url: git_repo_url, branch: git_repo_branch) do |dir|
           target_filename = "#{key_id}.p8"
           target_filepath = Pathname.new File.join(dir, target_filename)
         

data/lib/fastlane/plugin/yalantis_ci/actions/build_number_get_from_xcconfig.rb

@@ -0,0 +1,45 @@
+require 'pathname'
+
+module Fastlane
+  module Actions
+    class BuildNumberGetFromXcconfigAction < Action
+      def self.run(options)
+        path = options[:xcconfig_path]
+        contents = File.read(path)
+
+        match = /(?<=\bCURRENT_PROJECT_VERSION\s=\s)(?<value>[\d]+)/.match(contents)
+        return match[:value] unless match.nil?
+      end
+
+      def self.description
+        "Read Build Number from the passed xcconfig"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :xcconfig_path,
+            env_name: "BUILD_NUMBER_XCCONFIG_PATH",
+            description: "Path to the xcconfig file with Build Number",
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("Couldn't find .xcconfig file at path '#{value}'") unless File.exist?(File.expand_path(value))
+            end
+          )
+        ]
+      end
+
+      def self.output
+        []
+      end
+
+      def self.authors
+        ["Dima Vorona", "Yalantis"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/yalantis_ci/actions/build_number_set_to_xcconfig.rb

@@ -0,0 +1,56 @@
+require 'pathname'
+
+module Fastlane
+  module Actions
+    class BuildNumberSetToXcconfigAction < Action
+      def self.run(options)
+        build_number = options[:build_number] || Actions.lane_context[SharedValues::BUILD_NUMBER]
+        path = options[:xcconfig_path]
+
+        if build_number.nil?
+          UI.error("build_number can't be nil")
+        else
+          contents = File.readlines(path).join.gsub!(/(?<=\bCURRENT_PROJECT_VERSION\s=\s)([\d]+)/, build_number.to_s)
+          File.write(path, contents) unless contents.nil?
+        end
+      end
+
+      def self.description
+        "Stores a specified Build Number in the passed xcconfig"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :build_number,
+            env_name: "BUILD_NUMBER",
+            description: "Build number to be set to the .xcconfig",
+            optional: true,
+            type: Integer
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :xcconfig_path,
+            env_name: "BUILD_NUMBER_XCCONFIG_PATH",
+            description: "Path to the xcconfig file with Build Number",
+            type: String,
+            verify_block: proc do |value|
+              UI.user_error!("Couldn't find .xcconfig file at path '#{value}'") unless File.exist?(File.expand_path(value))
+            end
+          )
+        ]
+      end
+
+      def self.output
+        []
+      end
+
+      def self.authors
+        ["Dima Vorona", "Yalantis"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/yalantis_ci/actions/build_number_sync.rb

@@ -0,0 +1,136 @@
+require 'pathname'
+require_relative '../helper/git_helper'
+require 'json'
+require 'securerandom'
+
+module Fastlane
+  module Actions
+    class BuildNumberSyncAction < Action
+      def self.run(options)
+        build_number = read_from_remote(
+          git_repo_url: options[:git_repo_url],
+          git_repo_branch: options[:git_repo_branch],
+          payload_filepath: options[:git_filepath],
+          mutation_callback: options[:mutation_callback]
+        )
+        Actions.lane_context[SharedValues::BUILD_NUMBER] = build_number unless build_number.nil?
+        return build_number
+      end
+
+      def self.read_from_remote(git_repo_url:, git_repo_branch:, payload_filepath:, mutation_callback: nil)
+        build_number = nil
+        attempts = 0
+        total_attempts = 5
+
+        pwd = ENV['PWD']
+        pwd_managed_by_git = system("git -C \"#{pwd}\" rev-parse") == true
+        pwd_git_username = pwd_managed_by_git ? `git config --local --get user.name`.strip : nil
+        pwd_git_email = pwd_managed_by_git ? `git config --local --get user.email`.strip : nil
+
+        while build_number.nil? && attempts < total_attempts
+          Helper::GitHelper.clone_repo_in_tmp(repo_url: git_repo_url, branch: git_repo_branch, create_branch: true) do |dir|
+            attempts += 1
+
+            UI.message("Attempt #{attempts} out of #{total_attempts} to get build number")
+
+            filepath = File.join(dir, payload_filepath)
+            if File.exist?(filepath)
+              begin
+                remote_build_number = JSON.parse(File.read(filepath))['build_number']
+              rescue
+                remote_build_number = 1
+              end
+            else
+              remote_build_number = 1
+            end
+
+            build_number = mutation_callback != nil ? mutation_callback.call(remote_build_number) : remote_build_number
+
+            if build_number.kind_of?(Integer) && build_number > remote_build_number
+              payload_contents = JSON.pretty_generate({ 'build_number' => build_number, 'generation' => SecureRandom.uuid })
+              File.open(filepath, 'w+') { |file| file.write(payload_contents) }
+
+              add_user_config_if_needed(pwd_git_username: pwd_git_username, pwd_git_email: pwd_git_email)
+
+              Actions.sh("git add #{filepath} && git commit -m '[Build Number] Update Build Number to: #{build_number}'")
+              Actions.sh("git push #{git_repo_url} #{git_repo_branch}", error_callback: ->(result) { build_number = nil })
+            elsif build_number.kind_of?(Integer) && build_number < remote_build_number
+              UI.user_error!("It is unexpected to return build number less than a proposed one: #{build_number} vs #{remote_build_number}")
+            end
+          end
+        end
+
+        build_number
+      end
+
+      def self.add_user_config_if_needed(pwd_git_username:, pwd_git_email:)
+        variables = {'email' => pwd_git_email, 'name' => pwd_git_username }
+        variables.each do |key, value|
+          if `git config --local --get user.#{key}`.strip.empty?
+            `git config --local user.#{key} #{value}` unless value.empty?
+          end
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Read and increment version stored in a specified repo"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :git_repo_url,
+            env_name: "BUILD_NUMBER_GIT_REPO_URL",
+            description: "Git repo URL where Build Number is being stored",
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :git_repo_branch,
+            env_name: "BUILD_NUMBER_GIT_REPO_BRANCH",
+            description: "Git repo branch where Build Number is being stored",
+            type: String,
+            default_value: 'main'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :increment,
+            description: 'Whether value from remote should be incremented or not',
+            default_value: true,
+            verify_block: proc do |value|
+              UI.user_error!("Only `true` and `false` are allowed") unless value == true || value == false
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :git_filepath,
+            env_name: "BUILD_NUMBER_GIT_FILEPATH",
+            description: "Relative filepath to the file that contains build number",
+            type: String,
+            default_value: 'payload.json'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :mutation_callback,
+            description: 'A callback invoked with the build number from remote and expected build number to be returned',
+            optional: true,
+            type: Proc,
+            default_value: nil
+          )
+        ]
+      end
+
+      def self.output
+        ['BUILD_NUMBER', 'The new build number']
+      end
+
+      def self.authors
+        ["Dima Vorona", "Yalantis"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/yalantis_ci/actions/ci_setup.rb

@@ -17,15 +17,15 @@ module Fastlane
         Actions.lane_context[SharedValues::CI_UNIQUE_PROJECT_ID] = id
         ENV['CI_UNIQUE_PROJECT_ID'] = id
 
-        # We want to setup match repo regardless of the environment. 
+        # We want to setup match repo regardless of the environment
         # On both local and remote machine this should be set to the same value
         self.setup_match_repo(id)
 
-        if !Helper.ci?
+        unless Helper.ci?
           return
         end
 
-        self.setup_temp_keychain(id)
+        self.setup_temp_keychain(params[:keychain_name] || id)
 
         # Set output directory
         if params[:output_directory]
@@ -39,9 +39,9 @@ module Fastlane
           if params[:archive_name]
             extension = "xcarchive"
             archive_name = File.basename(params[:archive_name], File.extname(params[:archive_name])) + extension
-            archive_path = File.join(output_directory_path, params[:archive_name])
+            archive_path = File.join(output_directory_path, archive_name)
 
-            UI.message("Setting archive path to: \"#{output_directory_path}\".")
+            UI.message("Setting archive path to: \"#{output_directory_path}\"")
             ENV['GYM_ARCHIVE_PATH'] = archive_path
           end
         end
@@ -80,9 +80,7 @@ module Fastlane
       end
 
       def self.setup_temp_keychain(id)
-        job_id = ENV['CI_JOBENV_ID'] || ''
-
-        name = "#{id}-#{job_id}-fastlane"
+        name = "#{id}-fastlane"
         password = "#{name}-password"
         path = File.expand_path("~/Library/Keychains/#{name}.keychain-db")
 
@@ -118,35 +116,44 @@ module Fastlane
       end
 
       def self.available_options
-        # Define all options your action supports. 
-        
+        # Define all options your action supports
         # Below a few examples
         [
-          FastlaneCore::ConfigItem.new(key: :derived_data_path,
-                                       env_name: "CI_DERIVED_DATA_PATH",
-                                       description: "Path to the derived data to be used",
-                                       is_string: true,
-                                       default_value: "./build/DerivedData"
-                                       ),
-          FastlaneCore::ConfigItem.new(key: :output_directory,
-                                       env_name: "CI_OUTPUT_DIRECTORY",
-                                       description: "The directory in which the ipa file should be stored in as well as .xcarchive",
-                                       is_string: true,
-                                       default_value: "./build"
-                                       ),
-          FastlaneCore::ConfigItem.new(key: :archive_name,
-                                       env_name: "CI_ARCHIVE_NAME",
-                                       description: "The name of the .xcarchive to be used. Valid only when :output_directory is passed",
-                                       is_string: true,
-                                       optional: true
-                                       ),
-          FastlaneCore::ConfigItem.new(key: :project,
-                                       env_name: "XC_PROJECT",
-                                       description: "Path to the .xcodeproj to be used or any project-related description. Used during CI_UNIQUE_PROJECT_ID generation",
-                                       is_string: true,
-                                       optional: false
-                                       ),
-
+          FastlaneCore::ConfigItem.new(
+            key: :derived_data_path,
+            env_name: "CI_DERIVED_DATA_PATH",
+            description: "Path to the derived data to be used",
+            is_string: true,
+            default_value: "./build/DerivedData"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :keychain_name,
+            env_name: "CI_KEYCHAIN_NAME",
+            description: "Keychain name to be used for a particular job",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :output_directory,
+            env_name: "CI_OUTPUT_DIRECTORY",
+            description: "The directory in which the ipa file should be stored in as well as .xcarchive",
+            is_string: true,
+            default_value: "./build"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :archive_name,
+            env_name: "CI_ARCHIVE_NAME",
+            description: "The name of the .xcarchive to be used. Valid only when :output_directory is passed",
+            is_string: true,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :project,
+            env_name: "XC_PROJECT",
+            description: "Path to the .xcodeproj to be used or any project-related description. Used during CI_UNIQUE_PROJECT_ID generation",
+            is_string: true,
+            optional: false
+          ),
         ]
       end
 

data/lib/fastlane/plugin/yalantis_ci/helper/git_helper.rb

@@ -5,16 +5,15 @@ module Fastlane
 
   module Helper
     class GitHelper
-      
-      def self.clone_repo_in_tmp(repo_url, branch = 'master', create_branch_if_needed = false)
+      def self.clone_repo_in_tmp(repo_url:, branch: 'master', create_branch: false)
         temp_directory = `mktemp -d`.tr("\n", "")
 
         begin 
             Dir.chdir(temp_directory) do
                 Actions.sh("git clone -b #{branch} #{repo_url} #{Dir.pwd}") do |status, result, cmd|
-                    if status.success? != true && create_branch_if_needed
-                        Actions.sh("git clone #{repo_url} #{Dir.pwd} && git checkout -b #{branch}") do |status, result, cmd |
-                            if status.success? != true 
+                    if status.success? != true && create_branch
+                        Actions.sh("git clone #{repo_url} #{Dir.pwd} && git checkout -b #{branch}") do |status, result, cmd|
+                            if status.success? != true
                                 raise StandardError.new result
                             end
                         end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module YalantisCi
-    VERSION = "0.2.6"
+    VERSION = "0.3.9"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-yalantis_ci
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.9
 platform: ruby
 authors:
 - Dima Vorona
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-25 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane-plugin-firebase_app_distribution
@@ -150,7 +150,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description:
+description: 
 email: dmytro.vorona@yalantis.net
 executables: []
 extensions: []
@@ -162,18 +162,20 @@ files:
 - lib/fastlane/plugin/yalantis_ci/actions/app_store_connect_api_key_add_to_remote.rb
 - lib/fastlane/plugin/yalantis_ci/actions/app_store_connect_api_key_remove_from_remote.rb
 - lib/fastlane/plugin/yalantis_ci/actions/app_store_connect_api_key_set_from_remote.rb
+- lib/fastlane/plugin/yalantis_ci/actions/build_number_get_from_xcconfig.rb
+- lib/fastlane/plugin/yalantis_ci/actions/build_number_set_to_xcconfig.rb
+- lib/fastlane/plugin/yalantis_ci/actions/build_number_sync.rb
 - lib/fastlane/plugin/yalantis_ci/actions/ci_setup.rb
 - lib/fastlane/plugin/yalantis_ci/actions/ci_teardown.rb
 - lib/fastlane/plugin/yalantis_ci/actions/firebase_distribution_setup.rb
 - lib/fastlane/plugin/yalantis_ci/actions/install_brew_dependencies.rb
-- lib/fastlane/plugin/yalantis_ci/helper/ci_helper.rb
 - lib/fastlane/plugin/yalantis_ci/helper/git_helper.rb
 - lib/fastlane/plugin/yalantis_ci/version.rb
-homepage:
+homepage: 
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -188,8 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Set of utilities and useful actions to help setup CI for Yalantis projects
 test_files: []

data/lib/fastlane/plugin/yalantis_ci/helper/ci_helper.rb

@@ -1,17 +0,0 @@
-require 'fastlane_core/ui/ui'
-
-module Fastlane
-  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
-
-  module Helper
-    class CiHelper
-
-      # class methods that you define here become available in your action
-      # as `Helper::CiHelper.your_method`
-      #
-      def self.show_message
-        UI.message("Hello from the yalantis_ci plugin helper!")
-      end
-    end
-  end
-end