fastlane-plugin-versioning 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 42b94a8acc91d275f5e1cd891cfe65a9461b3ad9
-  data.tar.gz: b294b541af926d4b87361c1a90a29b1299a0a1f0
+SHA256:
+  metadata.gz: 168e204d03dbb77518ab76a1b29af130fdeb931ca84638cbf6c714cb6e2302a6
+  data.tar.gz: 2844377544c63bd02137e6d9fc4f878a4e0b3eae142f9fde6334fbe9eb6cc24f
 SHA512:
-  metadata.gz: 1b25a0bd3452f1f8a32c88e013670eb00b47d28db1506c830afae55ad7657ed4a3b48de2bc2b1384e4d039b41a64fb7fde2fe264e910ab84b1bb4e97643ae627
-  data.tar.gz: 7d41fa0832640bfa244aa2f54a49642e5deea52e7eeb8dfbaa5f9ffff1901aea59153f270a85e1a3faf3d43a7affc19e385abf6869c3ea74ef78f62b9453892b
+  metadata.gz: 664ed3aaf04e09e5c36744c83f03c7a4325a077bd45f52a1606216c10c0b85948f519907340f0e8df6a6f5968dea2b220ba1758a4e70fc3b91b145ce650b3f62
+  data.tar.gz: 4837f797b26815e6cc1565b1fa6faa6c164047c24be2ef1741d48819367d19b7bb87d31f4bea3510aabb6c8ac7697de55a883df20ba6d98931332e1432e37252

data/README.md

@@ -5,7 +5,6 @@
 [![Gem](https://img.shields.io/gem/v/fastlane-plugin-versioning.svg?style=flat)](http://rubygems.org/gems/fastlane-plugin-versioning)
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-versioning)
 
-
 ## Getting Started
 
 This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with fastlane-plugin-versioning, add it to your project by running:
@@ -17,14 +16,24 @@ fastlane add_plugin versioning
 ## About versioning
 
 Extends fastlane versioning actions. Allows to set/get versions without using agvtool and do some other small tricks.
-Note that all schemes that you pass to actions like `increment_version_number_in_plist` or `get_info_plist_path` in `scheme` parameter must be shared.
-To make your scheme shared go to "Manage schemes" in Xcode and tich "Shared" checkbox near your scheme.
+Note that all schemes that you pass to actions like `increment_version_number_in_plist`, `increment_build_number_in_xcodeproj` or `get_info_plist_path` in `scheme` parameter must be shared.
+To make your scheme shared go to "Manage schemes" in Xcode and tick "Shared" checkbox near your scheme.
+
+
+### what is this `plist_build_setting_support` stuff about?!
+If you have a xcodeproject and have updated to Xcode 11, you'll notice that if you change your build and version numbers through the UI, the actual numbers are now stored inside build settings inside build confiugration. The Info.plist file -- where they used to be stored -- now contains build setting variables (looks like `$(CURRENT_PROJECT_VERSION)` or `$(MARKETING_VERSION)`, for build number and version number respectively).
+If you are at this migration 'turning point', you have two options. you can either:
+1. simply add `plist_build_setting_support: true` to your plist action parameters
+2. change the command to be the xcodeproj variants - i.e. `increment_version_number_in_xcodeproj` or `increment_build_number_in_xcodeproj`
+
+these also apply to the `getters` of build and version numbers. 
+We will leave the plist actions in, as for those consumers who are limited to their upgrade path.
 
 ## Actions
 
 ### increment_version_number_in_plist
 
-Increment/set version number in Info.plist of specific target. Doesn't use agvtool (unlike default increment_version_number).
+Increment/set the version number in a Info.plist of specific target. Doesn't use `agvtool` (unlike default `increment_version_number`).
 
 ```ruby
 increment_version_number_in_plist # Automatically increment patch version number.
@@ -58,20 +67,42 @@ increment_version_number_in_plist(
   # (optional)
   target: 'TestTarget' # or `scheme`
 )
+
+increment_version_number_in_plist(
+  # specify specific version number (optional, omitting it increments patch version number)
+  version_number: '2.1.1',   
+  # (optional, you must specify the path to your main Xcode project if it is not in the project root directory
+  # or if you have multiple xcodeproj's in the root directory)
+  xcodeproj: './path/to/MyApp.xcodeproj'  
+  # (optional)
+  target: 'TestTarget' # or `scheme`
+  plist_build_setting_support: true, # optional, and defaulting to false.
+  # setting this will resolve the version number using the relevant build settings from your xcodeproj.
+)
+
 ```
 
+#### plist_build_setting_support
+`get_version_number_from_plist` supports the `plist_build_setting_support` flag, and will either use the other parameters you pass to resolve a particular build configuration to edit, _OR_ change __ALL__ of them.
+
+
 ### get_version_number_from_plist
 
-Get version number from Info.plist of specific target. Doesn't use agvtool (unlike default get_version_number).
+Get the version number from an Info.plist of specific target. Doesn't use `agvtool` (unlike default `get_version_number`).
 
 ```ruby
 version = get_version_number_from_plist(xcodeproj: 'Project.xcodeproj', # optional
                                         target: 'TestTarget', # optional, or `scheme`
                                         # optional, must be specified if you have different Info.plist build settings
                                         # for different build configurations
+                                        plist_build_setting_support: true, # optional, and defaulting to false. setting this will 
+                                        # resolve the version number using the relevant build settings from your xcodeproj.
                                         build_configuration_name: 'Release')
 ```
 
+#### plist_build_setting_support
+`get_version_number_from_plist` supports the `plist_build_setting_support` flag, and will either use the other parameters you pass to resolve a particular build configuration to retrieve, _OR_ pick the first it finds.
+
 ### get_app_store_version_number
 
 
@@ -98,7 +129,7 @@ version = get_version_number_from_git_branch(pattern: 'release-#')
 
 ### increment_build_number_in_plist
 
-Increment/set build number in Info.plist of specific target. Doesn't use agvtool (unlike default increment_version_number).
+Increment/set build number in Info.plist of specific target. Doesn't use `agvtool` (unlike default `increment_version_number`).
 
 ```ruby
 increment_build_number_in_plist # Automatically increments the last part of the build number.
@@ -107,16 +138,115 @@ increment_build_number_in_plist(
 )
 ```
 
+#### plist_build_setting_support
+`increment_build_number_in_plist` supports the `plist_build_setting_support` flag, and will either use the other parameters you pass to resolve a particular build configuration to edit, _OR_ change __ALL__ of them.
+
 ### get_build_number_from_plist
 
-Get build number from Info.plist of specific target. Doesn't use agvtool (unlike default get_build_number).
+Get the build number from an Info.plist of specific target. Doesn't use `agvtool` (unlike default `get_build_number`).
 
 ```ruby
 version = get_build_number_from_plist(xcodeproj: "Project.xcodeproj", # optional
+                                        target: 'TestTarget', # optional, or `scheme`
+                                        plist_build_setting_support: true, # optional, and defaulting to false. setting this will 
+                                        # resolve the build number using the relevant build settings from your xcodeproj.
+                                        build_configuration_name: 'Release') # optional, must be specified if you have different Info.plist build settings for different build configurations
+```
+
+#### plist_build_setting_support
+`get_build_number_from_plist` supports the `plist_build_setting_support` flag, and will either use the other parameters you pass to resolve a particular build configuration to retrieve, _OR_ pick the first it finds.
+
+### get_build_number_from_xcodeproj
+
+Get the build number from a xcodeproj - specific to a target. Doesn't use agvtool (unlike default `get_build_number`).
+
+```ruby
+version = get_build_number_from_xcodeproj(xcodeproj: "Project.xcodeproj", # optional
                                         target: 'TestTarget', # optional, or `scheme`
                                         build_configuration_name: 'Release') # optional, must be specified if you have different Info.plist build settings for different build configurations
 ```
 
+### get_version_number_from_xcodeproj
+
+Get the version number from a xcodeproj - specific to a target. Doesn't use agvtool (unlike default `get_build_number`).
+
+```ruby
+version = get_version_number_from_xcodeproj(xcodeproj: 'Project.xcodeproj', # optional
+                                        target: 'TestTarget', # optional, or `scheme`
+                                        # optional, must be specified if you have different Info.plist build settings
+                                        # for different build configurations
+                                        build_configuration_name: 'Release')
+```
+
+### increment_version_number_in_xcodeproj
+
+Increment/set the version number in a xcodeproj of specific target. Doesn't use `agvtool` (unlike default `increment_version_number`).
+
+```ruby
+increment_version_number_in_xcodeproj # Automatically increment patch version number.
+increment_version_number_in_xcodeproj(
+  bump_type: 'patch' # Automatically increment patch version number
+)
+increment_version_number_in_xcodeproj(
+  bump_type: 'minor' # Automatically increment minor version number
+)
+increment_version_number_in_xcodeproj(
+  bump_type: 'minor',
+  omit_zero_patch_version: true # if true omits zero in patch version(so 42.10.0 will become 42.10 and 42.10.1 will remain 42.10.1), default is false
+)
+increment_version_number_in_xcodeproj(
+  bump_type: 'major' # Automatically increment major version number
+)
+increment_version_number_in_xcodeproj(
+  version_number: '2.1.1' # Set a specific version number
+)
+increment_version_number_in_xcodeproj(
+  # Automatically increment patch version number. Use App Store version number as a source.
+  version_source: 'appstore'
+)
+
+increment_version_number_in_xcodeproj(
+  # specify specific version number (optional, omitting it increments patch version number)
+  version_number: '2.1.1',   
+  # (optional, you must specify the path to your main Xcode project if it is not in the project root directory
+  # or if you have multiple xcodeproj's in the root directory)
+  xcodeproj: './path/to/MyApp.xcodeproj'  
+  # (optional)
+  target: 'TestTarget' # or `scheme`
+)
+
+```
+
+### get_version_number_from_plist
+
+Get version number from Info.plist of specific target. Doesn't use agvtool (unlike default `get_version_number`).
+
+```ruby
+version = get_version_number_from_plist(xcodeproj: 'Project.xcodeproj', # optional
+                                        target: 'TestTarget', # optional, or `scheme`
+                                        # optional, must be specified if you have different Info.plist build settings
+                                        # for different build configurations
+                                        plist_build_setting_support: true, # optional, and defaulting to false. setting this will 
+                                        # resolve the version number using the relevant build settings from your xcodeproj.
+                                        build_configuration_name: 'Release')
+```
+
+#### plist_build_setting_support
+`get_version_number_from_plist` supports the `plist_build_setting_support` flag, and will either use the other parameters you pass to resolve a particular build configuration to retrieve, _OR_ pick the first it finds.
+
+### get_app_store_version_number
+
+
+```ruby
+version = get_app_store_version_number(xcodeproj: 'Project.xcodeproj', # optional
+                                        target: 'TestTarget', # optional, or `scheme`
+                                        # optional, must be specified if you have different Info.plist build settings
+                                        # for different build configurations
+                                        build_configuration_name: 'Release')
+)
+version = get_app_store_version_number(bundle_id: 'com.apple.Numbers')
+
+```
 
 ### get_info_plist_path
 
@@ -131,7 +261,7 @@ get_info_plist_path(xcodeproj: 'Test.xcodeproj', # optional
 
 ### ci_build_number
 
-Get CI system build number. Determined using environment variables defined by CI systems. Supports Jenkins, Travis CI, Circle CI, TeamCity, GoCD, Bamboo, Gitlab CI, Xcode Server, Bitbucket Pipelines and BuddyBuild. Returns `1` if build number cannot be determined. 
+Get CI system build number. Determined using environment variables defined by CI systems. Supports Jenkins, Travis CI, Circle CI, TeamCity, GoCD, Bamboo, Gitlab CI, Xcode Server, Bitbucket Pipelines, BuddyBuild, AppVeyor. Returns `1` if build number cannot be determined. 
 
 ```ruby
 increment_build_number_in_plist(
@@ -139,6 +269,8 @@ increment_build_number_in_plist(
 )
 ```
 
+
+
 ## Issues and Feedback
 
 For any other issues and feedback about this plugin, please submit it to this repository.

data/lib/fastlane/plugin/versioning/actions/ci_build_number.rb

@@ -38,10 +38,18 @@ module Fastlane
           return ENV['BITBUCKET_BUILD_NUMBER']
         end
 
+        if ENV.key?('BITRISE_BUILD_NUMBER')
+          return ENV['BITRISE_BUILD_NUMBER']
+        end
+
         if ENV.key?('BUDDYBUILD_BUILD_NUMBER')
           return ENV['BUDDYBUILD_BUILD_NUMBER']
         end
 
+        if ENV.key?('APPVEYOR_BUILD_NUMBER')
+          return ENV['APPVEYOR_BUILD_NUMBER']
+        end
+
         UI.error("Cannot detect current CI build number. Use 1 by default.")
         "1"
       end

data/lib/fastlane/plugin/versioning/actions/get_app_store_version_number.rb

@@ -9,11 +9,11 @@ module Fastlane
           bundle_id = params[:bundle_id]
         else
           if Helper.test?
-            plist = "/tmp/fastlane/tests/fastlane/Info.plist"
+            plist = "/tmp/fastlane/tests/fastlane/plist/Info.plist"
           else
             plist = GetInfoPlistPathAction.run(params)
           end
-          bundle_id = GetInfoPlistValueAction.run(path: plist, key: 'CFBundleIdentifier')
+          bundle_id = GetInfoPlistValueAction.run(path: plist, key: 'CFBundleIdentifier') # TODO: add same kind of flag to support build setting variables
         end
 
         uri = URI("http://itunes.apple.com/lookup?bundleId=#{bundle_id}")
@@ -42,7 +42,7 @@ module Fastlane
                              env_name: "FL_APPSTORE_VERSION_NUMBER_BUNDLE_ID",
                              description: "Bundle ID of the application",
                              optional: true,
-                             conflicting_options: [:xcodeproj, :target, :scheme, :build_configuration_name],
+                             conflicting_options: %i[xcodeproj target scheme build_configuration_name],
                              is_string: true),
           FastlaneCore::ConfigItem.new(key: :xcodeproj,
                              env_name: "FL_VERSION_NUMBER_PROJECT",
@@ -56,12 +56,12 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :target,
                              env_name: "FL_VERSION_NUMBER_TARGET",
                              optional: true,
-                             conflicting_options: [:bundle_id, :scheme],
+                             conflicting_options: %i[bundle_id scheme],
                              description: "Specify a specific target if you have multiple per project, optional"),
           FastlaneCore::ConfigItem.new(key: :scheme,
                              env_name: "FL_VERSION_NUMBER_SCHEME",
                              optional: true,
-                             conflicting_options: [:bundle_id, :target],
+                             conflicting_options: %i[bundle_id target],
                              description: "Specify a specific scheme if you have multiple per project, optional"),
           FastlaneCore::ConfigItem.new(key: :build_configuration_name,
                              optional: true,
@@ -75,7 +75,7 @@ module Fastlane
       end
 
       def self.is_supported?(platform)
-        [:ios, :mac].include? platform
+        %i[ios mac].include? platform
       end
     end
   end

data/lib/fastlane/plugin/versioning/actions/get_build_number_from_plist.rb

@@ -3,14 +3,22 @@ module Fastlane
     class GetBuildNumberFromPlistAction < Action
       def self.run(params)
         if Helper.test?
-          plist = "/tmp/fastlane/tests/fastlane/Info.plist"
+          plist = "/tmp/fastlane/tests/fastlane/plist/Info.plist"
         else
           plist = GetInfoPlistPathAction.run(params)
         end
 
-        version_number = GetInfoPlistValueAction.run(path: plist, key: 'CFBundleVersion')
+        if params[:plist_build_setting_support]
+          UI.important "build number will originate from xcodeproj"
+          build_number = GetBuildNumberFromXcodeprojAction.run(params)
+        else
+          UI.important "build number will originate from plist."
+          build_number = GetInfoPlistValueAction.run(path: plist, key: 'CFBundleVersion')
+        end
+
         # Store the number in the shared hash
-        Actions.lane_context[SharedValues::BUILD_NUMBER] = version_number
+        Actions.lane_context[SharedValues::BUILD_NUMBER] = build_number
+        build_number
       end
 
       #####################################################
@@ -23,7 +31,8 @@ module Fastlane
 
       def self.details
         [
-          "This action will return the current build number set on your project's Info.plist."
+          "This action will return the current build number set on your project's Info.plist.",
+          "note that you can pass plist_build_setting_support: true, in which case it will return from your xcodeproj."
         ].join(' ')
       end
 
@@ -49,8 +58,11 @@ module Fastlane
                              description: "Specify a specific scheme if you have multiple per project, optional"),
           FastlaneCore::ConfigItem.new(key: :build_configuration_name,
                              optional: true,
-                             description: "Specify a specific build configuration if you have different Info.plist build settings for each configuration")
-
+                             description: "Specify a specific build configuration if you have different Info.plist build settings for each configuration"),
+          FastlaneCore::ConfigItem.new(key: :plist_build_setting_support,
+                              description: "support automatic resolution of build setting from xcodeproj if not a literal value in the plist",
+                              is_string: false,
+                              default_value: false)
         ]
       end
 
@@ -65,7 +77,7 @@ module Fastlane
       end
 
       def self.is_supported?(platform)
-        [:ios, :mac].include? platform
+        %i[ios mac].include? platform
       end
     end
   end

data/lib/fastlane/plugin/versioning/actions/get_build_number_from_xcodeproj.rb

@@ -0,0 +1,127 @@
+module Fastlane
+  module Actions
+    class GetBuildNumberFromXcodeprojAction < Action
+      require 'xcodeproj'
+      require 'pathname'
+
+      def self.run(params)
+        unless params[:xcodeproj]
+          if Helper.test?
+            params[:xcodeproj] = "/tmp/fastlane/tests/fastlane/xcodeproj/versioning_fixture_project.xcodeproj"
+          else
+            params[:xcodeproj] = Dir["*.xcodeproj"][0] unless params[:xcodeproj]
+          end
+        end
+
+        if params[:target]
+          build_number = get_build_number_using_target(params)
+        elsif params[:build_configuration_name] && params[:scheme]
+          build_number = get_build_number_using_scheme(params)
+        else
+          UI.important "not enough information to pick a specific target or build configuration. taking the first one from the project"
+          build_number = get_first_build_number_in_xcodeproj(params)
+        end
+
+        Actions.lane_context[SharedValues::BUILD_NUMBER] = build_number
+        build_number
+      end
+
+      def self.get_first_build_number_in_xcodeproj(params)
+        project = Xcodeproj::Project.open(params[:xcodeproj])
+        configs = project.objects.select { |obj| select_build_configuration_predicate(nil, obj) }
+        configs.first.build_settings["CURRENT_PROJECT_VERSION"]
+      end
+
+      private_class_method
+      def self.select_build_configuration_predicate(name, configuration)
+        is_build_valid_configuration = configuration.isa == "XCBuildConfiguration" && !configuration.build_settings["PRODUCT_BUNDLE_IDENTIFIER"].nil?
+        is_build_valid_configuration &&= configuration.name == name unless name.nil?
+        return is_build_valid_configuration
+      end
+
+      def self.get_build_number_using_target(params)
+        project = Xcodeproj::Project.open(params[:xcodeproj])
+        if params[:target]
+          target = project.targets.detect { |t| t.name == params[:target] }
+        else
+          # firstly we are trying to find modern application target
+          target = project.targets.detect do |t|
+            t.kind_of?(Xcodeproj::Project::Object::PBXNativeTarget) &&
+              t.product_type == 'com.apple.product-type.application'
+          end
+          target = project.targets[0] if target.nil?
+        end
+
+        build_number = target.resolved_build_setting('CURRENT_PROJECT_VERSION', true)
+        UI.user_error! 'Cannot resolve build number build setting.' if build_number.nil? || build_number.empty?
+
+        if !(build_configuration_name = params[:build_configuration_name]).nil?
+          build_number = build_number[build_configuration_name]
+          UI.user_error! "Cannot resolve $(CURRENT_PROJECT_VERSION) build setting for #{build_configuration_name}." if plist.nil?
+        else
+          build_number = build_number.values.compact.uniq
+          UI.user_error! 'Cannot accurately resolve $(CURRENT_PROJECT_VERSION) build setting, try specifying :build_configuration_name.' if build_number.count > 1
+          build_number = build_number.first
+        end
+
+        build_number
+      end
+
+      def self.get_build_number_using_scheme(params)
+        config = { project: params[:xcodeproj], scheme: params[:scheme], configuration: params[:build_configuration_name] }
+        project = FastlaneCore::Project.new(config)
+        project.select_scheme
+
+        build_number = project.build_settings(key: 'CURRENT_PROJECT_VERSION')
+        UI.user_error! "Cannot resolve $(CURRENT_PROJECT_VERSION) in for the scheme #{config.scheme} with the name #{params.configuration}" if build_number.nil? || build_number.empty?
+        build_number
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Get the build number of your project"
+      end
+
+      def self.details
+        'Gets the $(CURRENT_PROJECT_VERSION) build setting using the specified parameters, or the first if not enough parameters are passed.'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                       env_name: "FL_BUILD_NUMBER_PROJECT",
+                                       description: "Optional, you must specify the path to your main Xcode project if it is not in the project root directory or if you have multiple *.xcodeproj's in the root directory",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Please pass the path to the project, not the workspace") if value.end_with? ".xcworkspace"
+                                         UI.user_error!("Could not find Xcode project at path '#{File.expand_path(value)}'") if !File.exist?(value) and !Helper.is_test?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :target,
+                                       env_name: "FL_BUILD_NUMBER_TARGET",
+                                       optional: true,
+                                       conflicting_options: [:scheme],
+                                       description: "Specify a specific target if you have multiple per project, optional"),
+          FastlaneCore::ConfigItem.new(key: :scheme,
+                                       env_name: "FL_BUILD_NUMBER_SCHEME",
+                                       optional: true,
+                                       conflicting_options: [:target],
+                                       description: "Specify a specific scheme if you have multiple per project, optional"),
+          FastlaneCore::ConfigItem.new(key: :build_configuration_name,
+                                       optional: true,
+                                       description: "Specify a specific build configuration if you have different build settings for each configuration")
+        ]
+      end
+
+      def self.authors
+        ["jdouglas-nz"]
+      end
+
+      def self.is_supported?(platform)
+        %i[ios mac].include? platform
+      end
+    end
+  end
+  end