fastlane-plugin-get_new_build_number 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c90e78136c51a621e69f71d95ec3eb015895652949041603ccd3cad27bf4ab4
-  data.tar.gz: 1c8c730ee099a35ac0a28a74410d350f4a54f6e999da11c0e38e092d1e632c4f
+  metadata.gz: a8e2528a341eb84b6b0c9ab295e585a60163a260ceda14d74a8cc31d16bcc5e3
+  data.tar.gz: 72960821aa6f1b7a18da431ca3528d476307317d8309d6efee2b6301532fd6d4
 SHA512:
-  metadata.gz: 7155f7c2b9055a367d0b3a11d010b275070426c70e82724bd2c65cd21de5d4540bbb8ffe73aca002fc769017c29558c36d8b9e3bd6ca42d8998378d922fabd95
-  data.tar.gz: d07f9e690bba3ad23a98c9d56219a75b014a7513c1b0efd8007db30693f755189db914b547f0dacd3bc8d2baad1abadb1e5ac177d18fdf9011d0b703d5315efe
+  metadata.gz: 126448527f46d456eceff761a9c2944d81c017d59f76e9f1d175c368521230e0330e16c18ab73e36a2dcb98781d9b28f866ff7615c5cd84d67374dcd52e331ea
+  data.tar.gz: d5fe2a28a184e0ee80ad791070a08a412cbea9a97e1c31a5f404d4da256407d9fb6f386d812cc2b095b2df3b180c7402be160cdba9934df6df62b911dcc9c9c0

data/LICENSE

@@ -1,21 +1,20 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Bartek Pacia <barpac02@gmail.com>
+Copyright (c) 2022 Bartek Pacia @bartekpacia
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,52 +1,224 @@
 # get_new_build_number plugin
 
-[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-get_new_build_number)
+[![fastlane Plugin Badge][fastlane-plugin-badge]][fastlane-plugin]
 
-## Getting Started
+I've often found myself wanting to _just assign new build number_ to my apps.
+This simple task turns out to be harder that it seems at first. There's a
+production build number (on App Store and Google Play), you might also have
+separate build numbers for beta, alpha, and other versions of your app.
+
+Fortunately, all of these services provide fastlane actions to get the latest
+build number.
+
+Unfortunately, every service provides app's build number in a bit different
+format, which makes it not-so-straightforward to get the latest-latest version
+number.
+
+This is my take at automating this.
+
+### Features
+
+Supported services:
+
+- [x] App Store (via [app_store_build_number][app-store])
+- [x] TestFlight (via [latest_testflight_build_number][testflight])
+- [x] Google Play (via [google_play_track_version_codes][google-play])
+- [x] Firebase App Distribution (via
+      [firebase_app_distribution_get_latest_release][fad])
+- [ ] App Center (via [appcenter_fetch_version_number][app-center])
 
-This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-get_new_build_number`, add it to your project by running:
+The _latest_ build number is persisted in
+[$TMPDIR][ruby-tmpdir]`/latest_build_number.txt`, so you can use it across
+`fastlane` invocations. For example, you could safely do:
 
 ```bash
+$ cd ios && bundle exec fastlane prod && cd ..
+$ cd android && bundle exec fastlane prod && cd ..
+$ cd symbian && bundle exec fastlane prod && cd .. # lol
+```
+
+The first `fastlane` invocation retrieves the _latest_ build number. Then, the 2
+subsequent invocations simply reuse the _latest_ build number from the file.
+
+The _new_ build number is derived using this complex forumla:
+
+```
+new_build_number = latest_build_number + 1
+```
+
+## Usage
+
+### Example 1
+
+Simple use case. This will only take the latest version from Google Play. This
+might not seem very useful at first, but is _is_ when you have different version
+codes for different tracks (`production`, `beta`, `alpha`, `internal`).
+
+Let's say that your Play Console looks like this:
+
+- `production` is at version code `60`
+- `beta` is at version code `61`
+- `alpha` is at 2 version codes: `64` and `65` (becasue you're doing some fancy
+  testing)
+
+In this case, `get_new_build_number` action would return `66` (because it is
+newer/higher/bigger than all the other build numbers).
+
+```ruby
+# android/fastlane/Fastfile
+
+default_platform(:android)
+
+platform :android do
+  desc "Deploy a new beta version to Google Play"
+  lane :beta do
+    build_number = get_new_build_number(
+      package_name: ENV["APP_PACKAGE_NAME"], # e.g com.example.yourapp
+      google_play_json_key_path: ENV["GOOGLE_PLAY_JSON_KEY_PATH"], # path to JSON key for authenticating with Google Play Android Developer API
+    ).to_s
+
+    build_android_app(
+      task: "bundleRelease",
+      project_dir: "..",
+      properties: {
+        "android.injected.version.code" => build_number,
+      },
+    )
+
+    upload_to_play_store(
+      track: "beta",
+      aab: "./build/outputs/bundle/release/android-release.aab",
+      json_key: ENV["GOOGLE_PLAY_JSON_KEY_PATH"],
+    )
+  end
+end
+```
+
+### Example 2
+
+If you provide more parameters, the plugin will take them into account. For
+example, if you pass `bundle_identifier` to `get_new_build_number`:
+
+```ruby
+platform :android do
+  desc "Deploy a new beta version to Google Play"
+  lane :beta do
+    build_number = get_new_build_number(
+      bundle_identifier: ENV["APP_BUNDLE_ID"], # e.g com.example.yourApp
+      package_name: ENV["APP_PACKAGE_NAME"], # e.g com.example.yourapp
+      google_play_json_key_path: ENV["GOOGLE_PLAY_JSON_KEY_PATH"], # path to JSON key for authenticating with Google Play Android Developer API
+    ).to_s
+
+    build_android_app(
+      task: "bundleRelease",
+      project_dir: "..",
+      properties: {
+        "android.injected.version.code" => build_number,
+      },
+    )
+
+    upload_to_play_store(
+      track: "beta",
+      aab: "./build/outputs/bundle/release/android-release.aab",
+      json_key: ENV["GOOGLE_PLAY_JSON_KEY_PATH"],
+    )
+  end
+end
+```
+
+then also build numbers in App Store will be taken into account.
+
+Building on the previous example, let's say that your Play Console looks like
+this (same as before):
+
+- `production` is at version code `60`
+- `beta` is at version code `61`
+- `alpha` is at 2 version codes: `64` and `65` (becasue you're doing some fancy
+  testing)
+
+And let's say that you App Store looks like this:
+
+- production is live at version code `81`
+
+In this case, `get_new_build_number` action would return `82` (because it is
+newer/higher/bigger than all the other build numbers). Of course, you have to be
+authenticated to App Store using
+[app_store_connect_api_key][app-store-connect-api-key].
+
+This makes it easy to keep version codes in sync in your app across different
+app stores.
+
+### Important note
+
+Please note that this action is simple and has no protection against concurrent
+builds. Is is probably unsafe to use in an environment when many releases happen
+in a short time frame.
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To
+get started with `fastlane-plugin-get_new_build_number`, add it to your project
+by running:
+
+```
+
 fastlane add_plugin get_new_build_number
+
 ```
 
 ## About get_new_build_number
 
 Retrieves the new build number for your app.
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+This plugin provides a single action, `get_new_build_number`. For now, see
+source code to learn how to use it. I might write some docs later.
 
 ## Example
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this
+plugin. Try it by cloning the repo, running `fastlane install_plugins` and
+`bundle exec fastlane test`.
 
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+**Note to author:** Please set up a sample project to make it easy for users to
+explore what your plugin does. Provide everything that is necessary to try out
+the plugin in this project (including a sample Xcode/Android project if
+necessary)
 
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run
 
 ```
+
 rake
+
 ```
 
 To automatically fix many of the styling issues, use
+
 ```
+
 rubocop -a
+
 ```
 
 ## Issues and Feedback
 
-For any other issues and feedback about this plugin, please submit it to this repository.
+For any other issues and feedback about this plugin, please submit it to this
+repository.
 
 ## Troubleshooting
 
-If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
-
-## Using _fastlane_ Plugins
-
-For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
-
-## About _fastlane_
-
-_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
+If you have trouble using plugins, check out the [Plugins
+Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/)
+guide.
+
+[fastlane-plugin-badge]: https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg
+[fastlane-plugin]: https://rubygems.org/gems/fastlane-plugin-get_new_build_number
+[ruby-tmpdir]: https://ruby-doc.org/stdlib-2.5.1/libdoc/tmpdir/rdoc/Dir.html#method-c-tmpdir
+[app-store]: https://docs.fastlane.tools/actions/app_store_build_number
+[testflight]: https://docs.fastlane.tools/actions/latest_testflight_build_number
+[google-play]: https://docs.fastlane.tools/actions/google_play_track_version_codes
+[fad]: https://github.com/fastlane/fastlane-plugin-firebase_app_distribution/blob/master/lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_get_latest_release.rb
+[app-center]: https://github.com/microsoft/fastlane-plugin-appcenter/blob/master/lib/fastlane/plugin/appcenter/actions/appcenter_fetch_version_number.rb
+[app-store-connect-api-key]: https://docs.fastlane.tools/actions/app_store_connect_api_key

data/lib/fastlane/plugin/get_new_build_number/actions/get_new_build_number_action.rb

@@ -14,38 +14,38 @@ module Fastlane
         UI.message("firebase_app_ios: #{params[:firebase_app_ios]}")
         UI.message("firebase_app_android: #{params[:firebase_app_android]}")
 
-        file = "#{Dir.tmpdir}/highest_build_number.txt"
-        UI.message "Temp file location: #{file}"
+        file = "#{Dir.tmpdir}/latest_build_number.txt"
+        UI.message("Temporary file location: #{file}")
 
-        if(File.exist?(file)) 
-          UI.success "File with new number file exists. Reading build number from it..." 
-          highest_build_number = File.read(file).to_i
-        else 
-          UI.message "File with new build number does not exist. New build number will be "\
-            "retrieved and file with it will be created."
-          highest_build_number = Helper::GetNewBuildNumberHelper.get_highest_build_number(
+        if File.exist?(file)
+          UI.success("File with new number file exists. Reading build number from it...")
+          latest_build_number = File.read(file).to_i
+        else
+          UI.message("File with new build number does not exist. New build number will be "\
+            "retrieved and temporary file with it will be created.")
+          latest_build_number = Helper::GetNewBuildNumberHelper.get_latest_build_number(
             bundle_identifier: params[:bundle_identifier],
             package_name: params[:package_name],
             google_play_json_key_path: params[:google_play_json_key_path],
             firebase_json_key_path: params[:firebase_json_key_path],
             firebase_app_ios: params[:firebase_app_ios],
-            firebase_app_android: params[:firebase_app_android],
+            firebase_app_android: params[:firebase_app_android]
           )
-          
+
           File.open(file, "w") do |f|
-            f.write "#{highest_build_number}\n"
-            UI.message "Wrote #{highest_build_number} to #{file}"
+            f.write("#{latest_build_number}\n")
+            UI.message("Wrote #{latest_build_number} to #{file}")
           end
         end
 
-        UI.success "Highest build number: #{highest_build_number}"
+        UI.success("Latest build number: #{latest_build_number}")
 
-        if highest_build_number.is_a? Integer
-          new_highest_build_number = highest_build_number + 1
-          UI.success "New build number: #{new_highest_build_number}"
-          return new_highest_build_number
+        if latest_build_number.kind_of?(Integer)
+          new_latest_build_number = latest_build_number + 1
+          UI.success("New build number: #{new_latest_build_number}")
+          return new_latest_build_number
         else
-          UI.error "Highest build number is not an Integer"
+          UI.error("Latest build number is not an Integer")
           return nil
 
         end
@@ -60,7 +60,7 @@ module Fastlane
       end
 
       def self.return_value
-        "An integer representing a new build number. It's the highest build "\
+        "An integer representing a new build number. It's the latest build "\
         "number collected from all services (e.g App Store, Google Play, App "\
         "Center) plus 1."
       end
@@ -77,43 +77,43 @@ module Fastlane
             env_name: "APP_BUNDLE_ID",
             description: "iOS bundle identifier",
             optional: true,
-            type: String,
+            type: String
           ),
           FastlaneCore::ConfigItem.new(
             key: :package_name,
             env_name: "APP_PACKAGE_NAME",
             description: "Android package name",
             optional: true,
-            type: String,
+            type: String
           ),
           FastlaneCore::ConfigItem.new(
             key: :google_play_json_key_path,
             env_name: "GOOGLE_PLAY_JSON_KEY_PATH",
             description: "Path to the Google Play Android Developer JSON key",
             optional: true,
-            type: String,
+            type: String
           ),
           FastlaneCore::ConfigItem.new(
             key: :firebase_json_key_path,
             env_name: "FIREBASE_JSON_KEY_PATH",
             description: "Path to the Firebase Admin JSON key",
             optional: true,
-            type: String,
+            type: String
           ),
           FastlaneCore::ConfigItem.new(
             key: :firebase_app_ios,
             env_name: "FIREBASE_APP_IOS",
             description: "Firebase iOS app ID",
             optional: true,
-            type: String,
+            type: String
           ),
           FastlaneCore::ConfigItem.new(
             key: :firebase_app_android,
             env_name: "FIREBASE_APP_ANDROID",
             description: "Firebase Android app ID",
             optional: true,
-            type: String,
-          ),
+            type: String
+          )
         ]
       end
 

data/lib/fastlane/plugin/get_new_build_number/helper/get_new_build_number_helper.rb

@@ -2,26 +2,25 @@ require 'fastlane_core/ui/ui'
 require 'tmpdir'
 
 module Fastlane
-  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
 
   module Helper
     class GetNewBuildNumberHelper
-
-      def self.get_highest_build_number(
-        bundle_identifier:nil,
-        package_name:nil,
-        google_play_json_key_path:nil,
-        firebase_json_key_path:nil,
-        firebase_app_ios:nil,
-        firebase_app_android:nil
+      def self.get_latest_build_number(
+        bundle_identifier: nil,
+        package_name: nil,
+        google_play_json_key_path: nil,
+        firebase_json_key_path: nil,
+        firebase_app_ios: nil,
+        firebase_app_android: nil
       )
         if bundle_identifier.nil? && package_name.nil?
-          UI.error "Both bundle_identifier and package_name are nil"
+          UI.error("Both bundle_identifier and package_name are nil")
           return nil
         end
 
         if package_name.nil? && google_play_json_key_path.nil?
-          UI.error "Both package_name and google_play_json_key_path are nil"
+          UI.error("Both package_name and google_play_json_key_path are nil")
           return nil
         end
 
@@ -29,87 +28,86 @@ module Fastlane
         unless bundle_identifier.nil?
           app_store_build_number = Fastlane::Actions::AppStoreBuildNumberAction.run(
             app_identifier: bundle_identifier,
-            platform: "IOS",
-          )  
+            platform: "IOS"
+          )
 
-          UI.message "build number (App Store): #{app_store_build_number}"
+          UI.message("Latest build number (App Store): #{app_store_build_number}")
         end
 
-        google_play_build_number_prod = get_version_code(
+        google_play_build_number_prod = get_google_play_build_number(
           track: "production",
           package_name: package_name,
-          json_key: google_play_json_key_path,
+          json_key: google_play_json_key_path
         )
 
-        google_play_build_number_beta = get_version_code(
+        google_play_build_number_beta = get_google_play_build_number(
           track: "beta",
           package_name: package_name,
-          json_key: google_play_json_key_path,
+          json_key: google_play_json_key_path
         )
 
-        google_play_build_number_alpha = get_version_code(
+        google_play_build_number_alpha = get_google_play_build_number(
           track: "alpha",
           package_name: package_name,
-          json_key: google_play_json_key_path,
+          json_key: google_play_json_key_path
         )
 
-        google_play_build_number_internal = get_version_code(
+        google_play_build_number_internal = get_google_play_build_number(
           track: "internal",
           package_name: package_name,
-          json_key: google_play_json_key_path,
+          json_key: google_play_json_key_path
         )
 
         google_play_build_number = [
           google_play_build_number_prod,
           google_play_build_number_beta,
           google_play_build_number_alpha,
-          google_play_build_number_internal,
+          google_play_build_number_internal
         ].max
 
-        UI.message "build number (Google Play Store): #{google_play_build_number}"
+        UI.message("Latest build number (Google Play Store): #{google_play_build_number}")
 
         fad_build_number_ios = 0
         unless firebase_app_ios.nil?
           fad_build_number_ios = Fastlane::Actions::FirebaseAppDistributionGetLatestReleaseAction.run(
             app: firebase_app_ios,
-            service_credentials_file: firebase_json_key_path,
+            service_credentials_file: firebase_json_key_path
           )[:buildVersion].to_i
-          
-          UI.message "build number (Firebase App Distribution iOS): #{fad_build_number_ios}"
+
+          UI.message("Latest build (Firebase App Distribution iOS): #{fad_build_number_ios}")
         end
 
         fad_build_number_android = 0
         unless firebase_app_android.nil?
           fad_build_number_android = Fastlane::Actions::FirebaseAppDistributionGetLatestReleaseAction.run(
             app: firebase_app_android,
-            service_credentials_file: firebase_json_key_path,
+            service_credentials_file: firebase_json_key_path
           )[:buildVersion].to_i
 
-          UI.message "build number (Firebase App Distribution Android): #{fad_build_number_android}"
+          UI.message("Latest build (Firebase App Distribution Android): #{fad_build_number_android}")
         end
 
         return [
           app_store_build_number,
           google_play_build_number,
           fad_build_number_ios,
-          fad_build_number_android,
+          fad_build_number_android
         ].max
       end
 
-      # Returns highest build number for the given track.
-      def self.get_version_code(track:, package_name:, json_key:)
-        begin
-          codes = Fastlane::Actions::GooglePlayTrackVersionCodesAction.run(
-            track: track,
-            package_name: package_name,
-            json_key: json_key,
-          )
+      # Returns the latest build number ("version code", in Android terminology)
+      # for the given Google Play track.
+      def self.get_google_play_build_number(track:, package_name:, json_key:)
+        codes = Fastlane::Actions::GooglePlayTrackVersionCodesAction.run(
+          track: track,
+          package_name: package_name,
+          json_key: json_key
+        )
 
-          return codes.max
-        rescue
-          UI.message "Version code not found for track #{track}"
-          return 0
-        end
+        return codes.max
+      rescue StandardError
+        UI.message("No build numbers found for track #{track}")
+        return 0
       end
     end
   end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module GetNewBuildNumber
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-get_new_build_number
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Bartek Pacia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-29 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler