Jetpack App: Update release toolkit to support Jetpack

.circleci/config.yml

@@ -21,7 +21,11 @@ commands:
           steps:
             - run:
                 name: Install Homebrew dependencies, if neeeded
-                command: brew update && xargs brew install --verbose < .circleci/.brewfile
+                command: |
+                  # Because the CircleCI image uses shallow clones, we need to unshallow them first. See https://bit.ly/3vx6EAL
+                  git -C /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core fetch --unshallow
+                  git -C /usr/local/Homebrew/Library/Taps/homebrew/homebrew-cask fetch --unshallow
+                  brew update && xargs brew install --verbose < .circleci/.brewfile
       - run:
           name: Install Ruby dependencies, if neeeded
           command: bundle check --path vendor/bundle || bundle install --with screenshots
@@ -57,7 +61,7 @@ jobs:
       # Save test results for timing analysis
       - store_test_results:
           path: test_results
-      
+
       # Coverage reports are sent to Codecov as part of running `rspec`, not as a CircleCI step.
       # We may wish to change this for consistency.
 
@@ -94,4 +98,3 @@ workflows:
               only: /.*/
             branches:
               ignore: /.*/
-

CHANGELOG.md

@@ -6,15 +6,16 @@
 
 ### Breaking Changes
 
-_None_
-
 ### New Features
 
-_None_
+* Support for a `version.properties` to manage app versioning - all existing paths remain intact and new paths are only used when a `version.properties` file is present.
+* Add support for providing an `app:` parameter to most versioning-related actions to allow support for multiple apps hosted in a monorepo
+* Supporting the new `version.properties` file also allows for the `HAS_ALPHA_VERSION` variable to be removed as the alpha reference in the properties file will be used going forward.
+* Clients adopting the new `version.properties` will need to implement a gradle task named `updateVersionProperties` to update the `version.properties` file.
 
 ### Bug Fixes
 
-_None_
+* Some cleanup to how we scope variables in some of our actions
 
 ### Internal Changes
 

lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_betabuild_prechecks.rb

@@ -11,11 +11,13 @@ def self.run(params)
         # Checkout develop and update
         Fastlane::Helper::GitHelper.checkout_and_pull('develop')
 
+        app = params[:app]
+
         # Check versions
-        release_version = Fastlane::Helper::Android::VersionHelper.get_release_version
-        message = "The following current version has been detected: #{release_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}\n"
-        alpha_release_version = Fastlane::Helper::Android::VersionHelper.get_alpha_version
-        message << "The following Alpha version has been detected: #{alpha_release_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}\n" unless alpha_release_version.nil?
+        release_version = Fastlane::Helper::Android::VersionHelper.get_release_version(app)
+        message = "[#{app}] The following current version has been detected: #{release_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}\n"
+        alpha_release_version = Fastlane::Helper::Android::VersionHelper.get_alpha_version(app)
+        message << "[#{app}] The following Alpha version has been detected: #{alpha_release_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}\n" unless alpha_release_version.nil?
 
         # Check branch
         app_version = Fastlane::Helper::Android::VersionHelper.get_public_version
@@ -48,9 +50,9 @@ def self.run(params)
       end
 
       def self.get_user_build_version(version, message)
-        UI.user_error!("Release branch for version #{version} doesn't exist. Abort.") unless Fastlane::Helper::GitHelper.checkout_and_pull(release: version)
+        UI.user_error!("[#{app}] Release branch for version #{version} doesn't exist. Abort.") unless Fastlane::Helper::GitHelper.checkout_and_pull(release: version)
         release_version = Fastlane::Helper::Android::VersionHelper.get_release_version
-        message << "Looking at branch release/#{version} as requested by user. Detected version: #{release_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}.\n"
+        message << "#{app}] Looking at branch release/#{version} as requested by user. Detected version: #{release_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}.\n"
         alpha_release_version = Fastlane::Helper::Android::VersionHelper.get_alpha_version
         message << "and Alpha Version: #{alpha_release_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}\n" unless alpha_release_version.nil?
         [release_version, alpha_release_version]
@@ -80,6 +82,10 @@ def self.available_options
                                        description: 'Skips confirmation',
                                        is_string: false, # true: verifies the input is a string, false: every kind of value
                                        default_value: false), # the default value if the user didn't provide one
+          FastlaneCore::ConfigItem.new(key: :app,
+                                       env_name: 'PROJECT_NAME',
+                                       description: 'The name of the app to get the release version for',
+                                       is_string: true), # true: verifies the input is a string, false: every kind of value
         ]
       end
 

lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_build_prechecks.rb

@@ -3,20 +3,22 @@ module Actions
     class AndroidBuildPrechecksAction < Action
       def self.run(params)
         require_relative '../../helper/android/android_version_helper'
+        require_relative '../../helper/git_helper'
 
         UI.user_error!("Can't build beta and final at the same time!") if params[:final] && params[:beta]
 
         Fastlane::Helper::GitHelper.ensure_on_branch!('release') unless other_action.is_ci()
 
+        app = params[:app]
         message = ''
-        beta_version = Fastlane::Helper::Android::VersionHelper.get_release_version() unless !params[:beta] && !params[:final]
-        alpha_version = Fastlane::Helper::Android::VersionHelper.get_alpha_version() if params[:alpha]
+        beta_version = Fastlane::Helper::Android::VersionHelper.get_release_version(app) unless !params[:beta] && !params[:final]
+        alpha_version = Fastlane::Helper::Android::VersionHelper.get_alpha_version(app) if params[:alpha]
 
         UI.user_error!("Can't build a final release out of this branch because it's configured as a beta release!") if params[:final] && Fastlane::Helper::Android::VersionHelper.is_beta_version?(beta_version)
 
-        message << "Building version #{beta_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}(#{beta_version[Fastlane::Helper::Android::VersionHelper::VERSION_CODE]}) (for upload to Release Channel)\n" if params[:final]
-        message << "Building version #{beta_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}(#{beta_version[Fastlane::Helper::Android::VersionHelper::VERSION_CODE]}) (for upload to Beta Channel)\n" if params[:beta]
-        message << "Building version #{alpha_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}(#{alpha_version[Fastlane::Helper::Android::VersionHelper::VERSION_CODE]}) (for upload to Alpha Channel)\n" if params[:alpha]
+        message << "[#{app}] Building version #{beta_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}(#{beta_version[Fastlane::Helper::Android::VersionHelper::VERSION_CODE]}) (for upload to Release Channel)\n" if params[:final]
+        message << "[#{app}] Building version #{beta_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}(#{beta_version[Fastlane::Helper::Android::VersionHelper::VERSION_CODE]}) (for upload to Beta Channel)\n" if params[:beta]
+        message << "[#{app}] Building version #{alpha_version[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]}(#{alpha_version[Fastlane::Helper::Android::VersionHelper::VERSION_CODE]}) (for upload to Alpha Channel)\n" if params[:alpha]
 
         if params[:skip_confirm]
           UI.message(message)
@@ -62,6 +64,10 @@ def self.available_options
                                        description: 'True if this is for a final build',
                                        is_string: false,
                                        default_value: false),
+          FastlaneCore::ConfigItem.new(key: :app,
+                                       env_name: 'PROJECT_NAME',
+                                       description: 'The name of the app to get the release version for',
+                                       is_string: true), # true: verifies the input is a string, false: every kind of value
         ]
       end
 

lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_bump_version_beta.rb

@@ -8,11 +8,22 @@ def self.run(params)
         require_relative '../../helper/android/android_version_helper'
 
         Fastlane::Helper::GitHelper.ensure_on_branch!('release')
-        create_config()
-        show_config()
+        app = params[:app]
 
-        UI.message 'Updating build.gradle...'
-        Fastlane::Helper::Android::VersionHelper.update_versions(@new_version_beta, @new_version_alpha)
+        current_version = Fastlane::Helper::Android::VersionHelper.get_release_version(product_name: app)
+        current_version_alpha = Fastlane::Helper::Android::VersionHelper.get_alpha_version(app)
+        new_version_beta = Fastlane::Helper::Android::VersionHelper.calc_next_beta_version(current_version, current_version_alpha)
+        new_version_alpha = current_version_alpha.nil? ? nil : Fastlane::Helper::Android::VersionHelper.calc_next_alpha_version(new_version_beta, current_version_alpha)
+
+        vname = Fastlane::Helper::Android::VersionHelper::VERSION_NAME
+        vcode = Fastlane::Helper::Android::VersionHelper::VERSION_CODE
+        UI.message("Current version[#{app}]: #{current_version[vname]}(#{current_version[vcode]})")
+        UI.message("Current alpha version[#{app}]: #{current_version_alpha[vname]}(#{current_version_alpha[vcode]})") unless current_version_alpha.nil?
+        UI.message("New beta version[#{app}]: #{new_version_beta[vname]}(#{new_version_beta[vcode]})")
+        UI.message("New alpha version[#{app}]: #{new_version_alpha[vname]}(#{new_version_alpha[vcode]})") unless current_version_alpha.nil?
+
+        UI.message 'Updating app version...'
+        Fastlane::Helper::Android::VersionHelper.update_versions(app, new_version_beta, new_version_alpha)
         UI.message 'Done!'
 
         Fastlane::Helper::Android::GitHelper.commit_version_bump()
@@ -23,14 +34,21 @@ def self.run(params)
       #####################################################
 
       def self.description
-        'Bumps the version of the app for a new beta'
+        'Bumps the version of the app for a new beta. Requires the `updateVersionProperties` gradle task to update the keys if you are using a `version.properties` file.'
       end
 
       def self.details
-        'Bumps the version of the app for a new beta'
+        'Bumps the version of the app for a new beta. Requires the `updateVersionProperties` gradle task to update the keys if you are using a `version.properties` file.'
       end
 
       def self.available_options
+        # Define all options your action supports.
+        [
+          FastlaneCore::ConfigItem.new(key: :app,
+                                       env_name: 'PROJECT_NAME',
+                                       description: 'The name of the app to get the release version for',
+                                       is_string: true), # true: verifies the input is a string, false: every kind of value
+        ]
       end
 
       def self.output
@@ -46,24 +64,6 @@ def self.authors
       def self.is_supported?(platform)
         platform == :android
       end
-
-      private
-
-      def self.create_config
-        @current_version = Fastlane::Helper::Android::VersionHelper.get_release_version()
-        @current_version_alpha = Fastlane::Helper::Android::VersionHelper.get_alpha_version()
-        @new_version_beta = Fastlane::Helper::Android::VersionHelper.calc_next_beta_version(@current_version, @current_version_alpha)
-        @new_version_alpha = ENV['HAS_ALPHA_VERSION'].nil? ? nil : Fastlane::Helper::Android::VersionHelper.calc_next_alpha_version(@new_version_beta, @current_version_alpha)
-      end
-
-      def self.show_config
-        vname = Fastlane::Helper::Android::VersionHelper::VERSION_NAME
-        vcode = Fastlane::Helper::Android::VersionHelper::VERSION_CODE
-        UI.message("Current version: #{@current_version[vname]}(#{@current_version[vcode]})")
-        UI.message("Current alpha version: #{@current_version_alpha[vname]}(#{@current_version_alpha[vcode]})") unless ENV['HAS_ALPHA_VERSION'].nil?
-        UI.message("New beta version: #{@new_version_beta[vname]}(#{@new_version_beta[vcode]})")
-        UI.message("New alpha version: #{@new_version_alpha[vname]}(#{@new_version_alpha[vcode]})") unless ENV['HAS_ALPHA_VERSION'].nil?
-      end
     end
   end
 end

lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_bump_version_final_release.rb

@@ -8,11 +8,20 @@ def self.run(params)
         require_relative '../../helper/android/android_version_helper'
 
         Fastlane::Helper::GitHelper.ensure_on_branch!('release')
-        create_config()
-        show_config()
+        app = params[:app]
 
-        UI.message 'Updating gradle.properties...'
-        Fastlane::Helper::Android::VersionHelper.update_versions(@final_version, @current_version_alpha)
+        current_version = Fastlane::Helper::Android::VersionHelper.get_release_version(product_name: app)
+        current_version_alpha = Fastlane::Helper::Android::VersionHelper.get_alpha_version(app)
+        final_version = Fastlane::Helper::Android::VersionHelper.calc_final_release_version(current_version, current_version_alpha)
+
+        vname = Fastlane::Helper::Android::VersionHelper::VERSION_NAME
+        vcode = Fastlane::Helper::Android::VersionHelper::VERSION_CODE
+        UI.message("Current version[#{app}]: #{current_version[vname]}(#{current_version[vcode]})")
+        UI.message("Current alpha version[#{app}]: #{current_version_alpha[vname]}(#{current_version_alpha[vcode]})") unless current_version_alpha.nil?
+        UI.message("New release version[#{app}]: #{final_version[vname]}(#{final_version[vcode]})")
+
+        UI.message 'Updating app version...'
+        Fastlane::Helper::Android::VersionHelper.update_versions(app, final_version, current_version_alpha)
         UI.message 'Done!'
 
         Fastlane::Helper::Android::GitHelper.commit_version_bump()
@@ -23,11 +32,21 @@ def self.run(params)
       #####################################################
 
       def self.description
-        'Bumps the version of the app for a new beta'
+        'Bumps the version of the app for a new beta. Requires the `updateVersionProperties` gradle task to update the keys if you are using a `version.properties` file.'
       end
 
       def self.details
-        'Bumps the version of the app for a new beta'
+        'Bumps the version of the app for a new beta. Requires the `updateVersionProperties` gradle task to update the keys if you are using a `version.properties` file.'
+      end
+
+      def self.available_options
+        # Define all options your action supports.
+        [
+          FastlaneCore::ConfigItem.new(key: :app,
+                                       env_name: 'PROJECT_NAME',
+                                       description: 'The name of the app to get the release version for',
+                                       is_string: true), # true: verifies the input is a string, false: every kind of value
+        ]
       end
 
       def self.authors
@@ -37,22 +56,6 @@ def self.authors
       def self.is_supported?(platform)
         platform == :android
       end
-
-      private
-
-      def self.create_config
-        @current_version = Fastlane::Helper::Android::VersionHelper.get_release_version()
-        @current_version_alpha = Fastlane::Helper::Android::VersionHelper.get_alpha_version()
-        @final_version = Fastlane::Helper::Android::VersionHelper.calc_final_release_version(@current_version, @current_version_alpha)
-      end
-
-      def self.show_config
-        vname = Fastlane::Helper::Android::VersionHelper::VERSION_NAME
-        vcode = Fastlane::Helper::Android::VersionHelper::VERSION_CODE
-        UI.message("Current version: #{@current_version[vname]}(#{@current_version[vcode]})")
-        UI.message("Current alpha version: #{@current_version_alpha[vname]}(#{@current_version_alpha[vcode]})") unless ENV['HAS_ALPHA_VERSION'].nil?
-        UI.message("New release version: #{@final_version[vname]}(#{@final_version[vcode]})")
-      end
     end
   end
 end