fastlane-plugin-versioning 0.4.5 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1f3c3811fd467e7d69c94314d4847e624fb962f5b32b52bc0f1e752b3fc6255
-  data.tar.gz: 3ef305e276491b37de4c7f7067fc8e1e5d0f6e10ce4fe36b5ad5ddc9e5d2809c
+  metadata.gz: 3b859783ec3eb0b788723835e3e9cea700b5924d1993a398f1381c319f4393d9
+  data.tar.gz: 3820aef2545a4054830e859c02497d4a8110a8931020758c123775113d15d96b
 SHA512:
-  metadata.gz: c26a7e8269c4d60aabab4d1c04323cedbd91c74df6042431275537fe1f3b6496526d66a93f317e60cd7b79d3db7c1b0c2cf9c40986b6b0dddef41f044e4f2509
-  data.tar.gz: fe91e4da9d9aeccb554f81bd9160bd40e41aea4414f68be97340ec26524c822af0737191d21c02d7d85c0cae922ad3088fda94f47ab352cc782f4ca64b839eb0
+  metadata.gz: a33054f02eb1fad905b17d001aaddfd82c4fecae4b8f203be72ae5d65129019ecea32445e6d53e1ae375828651019de0ae1833abbb7c6bb49f86743df036d692
+  data.tar.gz: 07a216fd6beca44bf81e57b8ee5ecef852094ca3589882d1ff983683022b0efa118ccb6be84814a0a4083d21a35363aa6a28b75904a8887ae359ece31b20b38c

data/README.md

@@ -21,12 +21,18 @@ To make your scheme shared go to "Manage schemes" in Xcode and tick "Shared" che
 
 
 ### 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 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 configuration. 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. 
+- Continue using the legacy method of inserting build and versions directly into plists by simply add `plist_build_setting_support: true` to your plist action parameters
+
+OR 
+
+- 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. 
+
+##### Warning for those migrating
+Verify your plist files are using the build variables (new) `$(CURRENT_PROJECT_VERSION)` or `$(MARKETING_VERSION)`. You can force this migration by simply modifying Version/Build fields for each one of your targets in UI. If you forget to make this change, or something else is writing and replacing it, xcodeproj actions will successfully update, but your build will have no reference to those values essentially becoming NOOP
+
 We will leave the plist actions in, as for those consumers who are limited to their upgrade path.
 
 ## Actions
@@ -57,6 +63,13 @@ increment_version_number_in_plist(
   # Automatically increment patch version number. Use App Store version number as a source.
   version_source: 'appstore'
 )
+increment_version_number_in_plist(
+  # Automatically increment patch version number. Use App Store version number as a source.
+  version_source: 'appstore',
+  # optional two letter country code: 
+  # specify if availability of your app is limited to a certain country
+  country: 'at'
+)
 
 increment_version_number_in_plist(
   # specify specific version number (optional, omitting it increments patch version number)
@@ -108,13 +121,28 @@ version = get_version_number_from_plist(xcodeproj: 'Project.xcodeproj', # option
 
 ```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')
-)
+                                       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(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',
+                                       # optional, must be specified for the lookup to succeed, 
+                                       # if your app is only published to one country 
+                                       # passed value must be a country code
+                                       country: 'at')
+
 version = get_app_store_version_number(bundle_id: 'com.apple.Numbers')
 
+version = get_app_store_version_number(bundle_id: 'com.apple.Numbers',
+                                       # optional two letter country code: 
+                                       # specify if availability of your app is limited to a certain country
+                                       country: 'at')
+
 ```
 
 ### get_version_number_from_git_branch
@@ -204,6 +232,13 @@ 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(
+  # Automatically increment patch version number. Use App Store version number as a source.
+  version_source: 'appstore',
+  # optional two letter country code: 
+  # specify if availability of your app is limited to a certain country
+  country: 'at'
+)
 
 increment_version_number_in_xcodeproj(
   # specify specific version number (optional, omitting it increments patch version number)
@@ -273,6 +308,14 @@ increment_build_number_in_plist(
 
 ## Issues and Feedback
 
+### SwiftPM
+
+SwiftPM can be tedious when using this plugin, at least in terms of git history and `xcodeproj`s. Up until recently, there were a number of annoyances caused by this plugin (and a downstream dependency of it) because writing to a project file would clobber some of the comment metadata inside of the project file and replace them - leaving you with the actual version change, but a number of other, less desirable changes too to hand pick through (or give up this plugin for). The advice is, update to `>= 0.4.6` of this plugin, and follow [this advice](https://github.com/SiarheiFedartsou/fastlane-plugin-versioning/issues/59#issuecomment-878255057) - which is to make sure not to include the `.git` at the end of your SwiftPM dependency URLs.
+
+### New / Fresh projects
+
+Note that you will need to set the build and version numbers through Xcode's UI at least once to use this plugin without weird `nil:NilClass` issues. See this [issue](https://github.com/SiarheiFedartsou/fastlane-plugin-versioning/issues/60) for context
+
 For any other issues and feedback about this plugin, please submit it to this repository.
 
 ## Troubleshooting

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

@@ -50,6 +50,10 @@ module Fastlane
           return ENV['APPVEYOR_BUILD_NUMBER']
         end
 
+        if ENV.key?('GITHUB_RUN_NUMBER')
+          return ENV['GITHUB_RUN_NUMBER']
+        end
+
         UI.error("Cannot detect current CI build number. Defaulting to \"1\".")
         "1"
       end

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

@@ -16,7 +16,11 @@ module Fastlane
           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}")
+        if params[:country]
+          uri = URI("http://itunes.apple.com/lookup?bundleId=#{bundle_id}&country=#{params[:country]}")
+        else
+          uri = URI("http://itunes.apple.com/lookup?bundleId=#{bundle_id}")
+        end
         Net::HTTP.get(uri)
 
         response = Net::HTTP.get_response(uri)
@@ -66,7 +70,11 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :build_configuration_name,
                              optional: true,
                              conflicting_options: [:bundle_id],
-                             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: :country,
+                             optional: true,
+                             description: "Pass an optional country code, if your app's availability is limited to specific countries",
+                             is_string: true)
         ]
       end
 

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

@@ -34,7 +34,7 @@ module Fastlane
 
       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.isa == "XCBuildConfiguration" && !configuration.resolve_build_setting('PRODUCT_BUNDLE_IDENTIFIER').nil?
         is_build_valid_configuration &&= configuration.name == name unless name.nil?
         return is_build_valid_configuration
       end

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

@@ -41,7 +41,7 @@ module Fastlane
 
       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.isa == "XCBuildConfiguration" && !configuration.resolve_build_setting('PRODUCT_BUNDLE_IDENTIFIER').nil?
         is_build_valid_configuration &&= configuration.name == name unless name.nil?
         return is_build_valid_configuration
       end
@@ -59,10 +59,16 @@ module Fastlane
           target = project.targets[0] if target.nil?
         end
 
-        target.build_configurations.each do |config|
+        if params[:build_configuration_name]
+          config = target.build_configurations.detect { |c| c.name == params[:build_configuration_name]}
           UI.message "updating #{config.name} to build #{next_build_number}"
           config.build_settings["CURRENT_PROJECT_VERSION"] = next_build_number
-        end unless target.nil?
+        else
+          target.build_configurations.each do |config|
+            UI.message "updating #{config.name} to build #{next_build_number}"
+            config.build_settings["CURRENT_PROJECT_VERSION"] = next_build_number
+          end unless target.nil?
+        end
 
         project.save
       end

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

@@ -129,6 +129,10 @@ module Fastlane
                                          UI.user_error!("Available values are 'plist' and 'appstore'") unless ['plist', 'appstore'].include? value
                                        end,
                                        description: "Source version to increment. Available options: plist, appstore"),
+          FastlaneCore::ConfigItem.new(key: :country,
+                                       optional: true,
+                                       description: "Pass an optional country code, if your app's availability is limited to specific countries",
+                                       is_string: true),
           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,

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

@@ -61,7 +61,7 @@ module Fastlane
 
       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.isa == "XCBuildConfiguration" && !configuration.resolve_build_setting('PRODUCT_BUNDLE_IDENTIFIER').nil?
         is_build_valid_configuration &&= configuration.name == name unless name.nil?
         return is_build_valid_configuration
       end
@@ -79,10 +79,17 @@ module Fastlane
           target = project.targets[0] if target.nil?
         end
 
-        target.build_configurations.each do |config|
+        if params[:build_configuration_name]
+          config = target.build_configurations.detect { |c| c.name == params[:build_configuration_name]}
           UI.message "updating #{config.name} to version #{next_version_number}"
           config.build_settings["MARKETING_VERSION"] = next_version_number
-        end unless target.nil?
+        else
+          target.build_configurations.each do |config|
+            UI.message "updating #{config.name} to version #{next_version_number}"
+            config.build_settings["MARKETING_VERSION"] = next_version_number
+          end unless target.nil?
+        end
+
 
         project.save
       end
@@ -159,6 +166,10 @@ module Fastlane
                           UI.user_error!("Available values are 'xcodeproj' and 'appstore'") unless ['xcodeproj', 'appstore'].include? value
                         end,
                         description: "Source version to increment. Available options: xcodeproj, appstore"),
+          FastlaneCore::ConfigItem.new(key: :country,
+                        optional: true,
+                        description: "Pass an optional country code, if your app's availability is limited to specific countries",
+                        is_string: true),
           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,

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Versioning
-    VERSION = "0.4.5"
+    VERSION = "0.5.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-versioning
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.1
 platform: ruby
 authors:
 - Siarhei Fiedartsou
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-02 00:00:00.000000000 Z
+date: 2022-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry