fastlane-plugin-wpmreleasetoolkit 9.0.1 → 9.2.0

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_finalize_prechecks.rb

@@ -15,7 +15,15 @@ module Fastlane
         current_branch = Fastlane::Helper::GitHelper.current_git_branch
         UI.user_error!("Current branch - '#{current_branch}' - is not a release branch. Abort.") unless current_branch.start_with?('release/')
 
-        version = Fastlane::Helper::Android::VersionHelper.get_public_version
+        project_root_folder = params[:project_root_folder]
+        project_name = params[:project_name]
+        build_gradle_path = params[:build_gradle_path] || (File.join(project_root_folder || '.', project_name, 'build.gradle') unless project_name.nil?)
+        version_properties_path = params[:version_properties_path] || File.join(project_root_folder || '.', 'version.properties')
+
+        version = Fastlane::Helper::Android::VersionHelper.get_public_version(
+          build_gradle_path: build_gradle_path,
+          version_properties_path: version_properties_path
+        )
         message = "Finalizing release: #{version}\n"
         if params[:skip_confirm]
           UI.message(message)
@@ -51,6 +59,22 @@ module Fastlane
                                        description: 'Skips confirmation',
                                        type: Boolean,
                                        default_value: false), # the default value if the user didn't provide one
+          FastlaneCore::ConfigItem.new(key: :build_gradle_path,
+                                       description: 'Path to the build.gradle file',
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: %i[project_name
+                                                               project_root_folder
+                                                               version_properties_path]),
+          FastlaneCore::ConfigItem.new(key: :version_properties_path,
+                                       description: 'Path to the version.properties file',
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: %i[build_gradle_path
+                                                               project_name
+                                                               project_root_folder]),
+          Fastlane::Helper::Deprecated.project_root_folder_config_item,
+          Fastlane::Helper::Deprecated.project_name_config_item,
         ]
       end
 

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_get_alpha_version.rb

@@ -3,7 +3,16 @@ module Fastlane
     class AndroidGetAlphaVersionAction < Action
       def self.run(params)
         require_relative '../../helper/android/android_version_helper'
-        Fastlane::Helper::Android::VersionHelper.get_alpha_version
+
+        project_root_folder = params[:project_root_folder]
+        project_name = params[:project_name]
+        build_gradle_path = params[:build_gradle_path] || (File.join(project_root_folder || '.', project_name, 'build.gradle') unless project_name.nil?)
+        version_properties_path = params[:version_properties_path] || File.join(project_root_folder || '.', 'version.properties')
+
+        Fastlane::Helper::Android::VersionHelper.get_alpha_version(
+          build_gradle_path: build_gradle_path,
+          version_properties_path: version_properties_path
+        )
       end
 
       #####################################################
@@ -19,7 +28,24 @@ module Fastlane
       end
 
       def self.available_options
-        # Define all options your action supports.
+        [
+          FastlaneCore::ConfigItem.new(key: :build_gradle_path,
+                                       description: 'Path to the build.gradle file',
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: %i[project_name
+                                                               project_root_folder
+                                                               version_properties_path]),
+          FastlaneCore::ConfigItem.new(key: :version_properties_path,
+                                       description: 'Path to the version.properties file',
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: %i[build_gradle_path
+                                                               project_name
+                                                               project_root_folder]),
+          Fastlane::Helper::Deprecated.project_root_folder_config_item,
+          Fastlane::Helper::Deprecated.project_name_config_item,
+        ]
       end
 
       def self.output

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_get_app_version.rb

@@ -3,7 +3,16 @@ module Fastlane
     class AndroidGetAppVersionAction < Action
       def self.run(params)
         require_relative '../../helper/android/android_version_helper'
-        Fastlane::Helper::Android::VersionHelper.get_public_version
+
+        project_root_folder = params[:project_root_folder]
+        project_name = params[:project_name]
+        build_gradle_path = params[:build_gradle_path] || (File.join(project_root_folder || '.', project_name, 'build.gradle') unless project_name.nil?)
+        version_properties_path = params[:version_properties_path] || File.join(project_root_folder || '.', 'version.properties')
+
+        Fastlane::Helper::Android::VersionHelper.get_public_version(
+          build_gradle_path: build_gradle_path,
+          version_properties_path: version_properties_path
+        )
       end
 
       #####################################################
@@ -19,7 +28,24 @@ module Fastlane
       end
 
       def self.available_options
-        # Define all options your action supports.
+        [
+          FastlaneCore::ConfigItem.new(key: :build_gradle_path,
+                                       description: 'Path to the build.gradle file',
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: %i[project_name
+                                                               project_root_folder
+                                                               version_properties_path]),
+          FastlaneCore::ConfigItem.new(key: :version_properties_path,
+                                       description: 'Path to the version.properties file',
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: %i[build_gradle_path
+                                                               project_name
+                                                               project_root_folder]),
+          Fastlane::Helper::Deprecated.project_root_folder_config_item,
+          Fastlane::Helper::Deprecated.project_name_config_item,
+        ]
       end
 
       def self.output

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_get_release_version.rb

@@ -3,7 +3,16 @@ module Fastlane
     class AndroidGetReleaseVersionAction < Action
       def self.run(params)
         require_relative '../../helper/android/android_version_helper'
-        Fastlane::Helper::Android::VersionHelper.get_release_version
+
+        project_root_folder = params[:project_root_folder]
+        project_name = params[:project_name]
+        build_gradle_path = params[:build_gradle_path] || (File.join(project_root_folder || '.', project_name, 'build.gradle') unless project_name.nil?)
+        version_properties_path = params[:version_properties_path] || File.join(project_root_folder || '.', 'version.properties')
+
+        Fastlane::Helper::Android::VersionHelper.get_release_version(
+          build_gradle_path: build_gradle_path,
+          version_properties_path: version_properties_path
+        )
       end
 
       #####################################################
@@ -19,7 +28,24 @@ module Fastlane
       end
 
       def self.available_options
-        # Define all options your action supports.
+        [
+          FastlaneCore::ConfigItem.new(key: :build_gradle_path,
+                                       description: 'Path to the build.gradle file',
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: %i[project_name
+                                                               project_root_folder
+                                                               version_properties_path]),
+          FastlaneCore::ConfigItem.new(key: :version_properties_path,
+                                       description: 'Path to the version.properties file',
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: %i[build_gradle_path
+                                                               project_name
+                                                               project_root_folder]),
+          Fastlane::Helper::Deprecated.project_root_folder_config_item,
+          Fastlane::Helper::Deprecated.project_name_config_item,
+        ]
       end
 
       def self.output

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_tag_build.rb

@@ -5,8 +5,19 @@ module Fastlane
         require_relative '../../helper/android/android_version_helper'
         require_relative '../../helper/android/android_git_helper'
 
-        release_ver = Fastlane::Helper::Android::VersionHelper.get_release_version
-        alpha_ver = Fastlane::Helper::Android::VersionHelper.get_alpha_version
+        project_root_folder = params[:project_root_folder]
+        project_name = params[:project_name]
+        build_gradle_path = params[:build_gradle_path] || (File.join(project_root_folder || '.', project_name, 'build.gradle') unless project_name.nil?)
+        version_properties_path = params[:version_properties_path] || File.join(project_root_folder || '.', 'version.properties')
+
+        release_ver = Fastlane::Helper::Android::VersionHelper.get_release_version(
+          build_gradle_path: build_gradle_path,
+          version_properties_path: version_properties_path
+        )
+        alpha_ver = Fastlane::Helper::Android::VersionHelper.get_alpha_version(
+          build_gradle_path: build_gradle_path,
+          version_properties_path: version_properties_path
+        )
         Fastlane::Helper::GitHelper.create_tag(release_ver[Fastlane::Helper::Android::VersionHelper::VERSION_NAME])
         Fastlane::Helper::GitHelper.create_tag(alpha_ver[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]) unless alpha_ver.nil? || (params[:tag_alpha] == false)
       end
@@ -30,6 +41,22 @@ module Fastlane
                                        description: 'True to skip tagging the alpha version',
                                        type: Boolean,
                                        default_value: true),
+          FastlaneCore::ConfigItem.new(key: :build_gradle_path,
+                                       description: 'Path to the build.gradle file',
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: %i[project_name
+                                                               project_root_folder
+                                                               version_properties_path]),
+          FastlaneCore::ConfigItem.new(key: :version_properties_path,
+                                       description: 'Path to the version.properties file',
+                                       type: String,
+                                       optional: true,
+                                       conflicting_options: %i[build_gradle_path
+                                                               project_name
+                                                               project_root_folder]),
+          Fastlane::Helper::Deprecated.project_root_folder_config_item,
+          Fastlane::Helper::Deprecated.project_name_config_item,
         ]
       end
 

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_update_release_notes.rb

@@ -8,6 +8,8 @@ module Fastlane
         require_relative '../../helper/release_notes_helper'
         require_relative '../../helper/git_helper'
 
+        UI.deprecated('The `PROJECT_ROOT_FOLDER` environment variable is deprecated and will be removed in a future release. Please pass a path to the `release_notes_file_path` param instead.') unless ENV['PROJECT_ROOT_FOLDER'].nil?
+
         path = params[:release_notes_file_path]
         next_version = Fastlane::Helper::Android::VersionHelper.calc_next_release_short_version(params[:new_version])
 

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/copy_branch_protection_action.rb

@@ -0,0 +1,80 @@
+require 'fastlane/action'
+require_relative '../../helper/github_helper'
+
+module Fastlane
+  module Actions
+    class CopyBranchProtectionAction < Action
+      def self.run(params)
+        repository = params[:repository]
+        from_branch = params[:from_branch]
+        to_branch = params[:to_branch]
+
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+
+        response = begin
+          github_helper.get_branch_protection(
+            repository: repository,
+            branch: from_branch
+          )
+        rescue Octokit::NotFound
+          UI.user_error!("Branch `#{from_branch}` of repository `#{repository}` was not found.")
+        end
+        UI.user_error!("Branch `#{from_branch}` does not have any branch protection set up.") if response.nil?
+        settings = Fastlane::Helper::GithubHelper.branch_protection_api_response_to_normalized_hash(response)
+
+        response = begin
+          github_helper.set_branch_protection(
+            repository: repository,
+            branch: to_branch,
+            **settings
+          )
+        rescue Octokit::NotFound
+          UI.user_error!("Branch `#{to_branch}` of repository `#{repository}` was not found.")
+        end
+
+        Fastlane::Helper::GithubHelper.branch_protection_api_response_to_normalized_hash(response)
+      end
+
+      def self.description
+        'Copies the branch protection settings of one branch onto another branch'
+      end
+
+      def self.details
+        description
+      end
+
+      def self.return_value
+        'The hash corresponding to the response returned by the API request, and containing the applied protection settings'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :repository,
+                                       env_name: 'GHHELPER_REPOSITORY',
+                                       description: 'The remote path of the GH repository on which we work',
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :from_branch,
+                                       env_name: 'GHHELPER_FROM_BRANCH',
+                                       description: 'The branch to copy the protection settings from',
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :to_branch,
+                                       env_name: 'GHHELPER_TO_BRANCH',
+                                       description: 'The branch to copy the protection settings to',
+                                       optional: false,
+                                       type: String),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
+        ]
+      end
+
+      def self.authors
+        ['Automattic']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/{removebranchprotection_action.rb → remove_branch_protection_action.rb}

@@ -3,42 +3,34 @@ require_relative '../../helper/github_helper'
 
 module Fastlane
   module Actions
-    class RemovebranchprotectionAction < Action
+    class RemoveBranchProtectionAction < Action
       def self.run(params)
         repository = params[:repository]
         branch_name = params[:branch]
 
-        branch_url = "https://api.github.com/repos/#{repository}/branches/#{branch_name}"
-        restrictions = { url: "#{branch_url}/protection/restrictions", users_url: "#{branch_url}/protection/restrictions/users", teams_url: "#{branch_url}/protection/restrictions/teams", users: [], teams: [] }
-        required_pull_request_reviews = { url: "#{branch_url}/protection/required_pull_request_reviews", dismiss_stale_reviews: false, require_code_owner_reviews: false }
-
         github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
         github_helper.remove_branch_protection(
           repository: repository,
-          branch: branch_name,
-          restrictions: restrictions,
-          enforce_admins: nil,
-          required_pull_request_reviews: required_pull_request_reviews
+          branch: branch_name
         )
+      rescue Octokit::NotFound
+        UI.user_error!("Branch `#{branch_name}` of repository `#{repository}` was not found.")
+      rescue Octokit::BranchNotProtected
+        UI.message("Note: Branch `#{branch_name}` was not protected in the first place.")
       end
 
       def self.description
-        "Removes the 'release branch' protection state for the specified branch"
+        'Removes the protection settings for the specified branch'
       end
 
-      def self.authors
-        ['Automattic']
+      def self.details
+        description
       end
 
       def self.return_value
         # If your method provides a return value, you can describe here what it does
       end
 
-      def self.details
-        # Optional:
-        "Sets the 'release branch' protection state for the specified branch"
-      end
-
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :repository,
@@ -55,9 +47,24 @@ module Fastlane
         ]
       end
 
+      def self.authors
+        ['Automattic']
+      end
+
       def self.is_supported?(platform)
         true
       end
     end
+
+    # For backwards compatibility
+    class RemovebranchprotectionAction < RemoveBranchProtectionAction
+      def self.category
+        :deprecated
+      end
+
+      def self.deprecated_notes
+        "This action has been renamed `#{superclass.action_name}`"
+      end
+    end
   end
 end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/set_branch_protection_action.rb

@@ -0,0 +1,153 @@
+require 'fastlane/action'
+require_relative '../../helper/github_helper'
+
+module Fastlane
+  module Actions
+    class SetBranchProtectionAction < Action
+      def self.run(params)
+        repository = params[:repository]
+        branch_name = params[:branch]
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+
+        settings = if params[:keep_existing_settings_unchanged]
+                     Fastlane::Helper::GithubHelper.branch_protection_api_response_to_normalized_hash(
+                       github_helper.get_branch_protection(repository: repository, branch: branch_name)
+                     )
+                   else
+                     {}
+                   end
+
+        # `required_status_checks` field — only override existing `checks` subfield if param provided
+        unless params[:required_ci_checks].nil?
+          if params[:required_ci_checks].empty?
+            settings[:required_status_checks] = nil # explicitly completely delete existing check requirement
+          else
+            settings[:required_status_checks] ||= { strict: false }
+            settings[:required_status_checks][:checks] = params[:required_ci_checks].map { |ctx| { context: ctx } }
+          end
+        end
+
+        # `enforce_admins` field — only override existing value if param provided
+        if params[:enforce_admins].nil?
+          settings[:enforce_admins] ||= nil # parameter is required to be provided, even if nil (aka false) value
+        else
+          settings[:enforce_admins] = params[:enforce_admins]
+        end
+
+        # `required_pull_request_reviews` field — only override `required_approving_review_count` subfield if param provided
+        settings[:required_pull_request_reviews] ||= {
+          dismiss_stale_reviews: false,
+          require_code_owner_reviews: false
+        }
+        unless params[:required_approving_review_count].nil?
+          settings[:required_pull_request_reviews][:required_approving_review_count] = params[:required_approving_review_count]
+        end
+
+        # `restrictions` field
+        settings[:restrictions] ||= { users: [], teams: [] }
+
+        # `allow_force_pushes` field — only override existing value if param provided
+        unless params[:allow_force_pushes].nil?
+          settings[:allow_force_pushes] = params[:allow_force_pushes]
+        end
+
+        # `lock_branch` field — only override existing value if param provided
+        unless params[:lock_branch].nil?
+          settings[:lock_branch] = params[:lock_branch]
+        end
+
+        # API Call - See https://docs.github.com/en/rest/branches/branch-protection#update-branch-protection
+        response = github_helper.set_branch_protection(
+          repository: repository,
+          branch: branch_name,
+          **settings
+        )
+
+        Fastlane::Helper::GithubHelper.branch_protection_api_response_to_normalized_hash(response)
+      rescue Octokit::NotFound => e
+        UI.user_error!("Branch `#{branch_name}` of repository `#{repository}` was not found.\n#{e.message}")
+      end
+
+      def self.description
+        'Sets the protection state for the specified branch'
+      end
+
+      def self.details
+        description
+      end
+
+      def self.return_value
+        'The hash corresponding to the response returned by the API request, and containing the applied protection settings'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :repository,
+                                       env_name: 'GHHELPER_REPOSITORY',
+                                       description: 'The slug of the GH repository on which we work',
+                                       optional: false,
+                                       type: String),
+          # NOTE: GitHub branch protection API doesn't allow wildcard characters for the branch parameter
+          FastlaneCore::ConfigItem.new(key: :branch,
+                                       env_name: 'GHHELPER_BRANCH',
+                                       description: 'The branch to protect',
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :keep_existing_settings_unchanged,
+                                       description: 'If set to true, will only change the settings that are explicitly provided to the action, ' \
+                                       + 'while keeping the values of other existing protection settings (if any) unchanged. If false, it will ' \
+                                       + 'discard any existing branch protection setting if any before setting just the ones provided ' \
+                                       + '(and leaving the rest with default GitHub values)',
+                                       default_value: true,
+                                       type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :required_ci_checks,
+                                       description: 'If provided, specifies the list of CI status checks to mark as required. If not provided (nil), will keep existing ones',
+                                       optional: true,
+                                       default_value: nil,
+                                       type: Array),
+          FastlaneCore::ConfigItem.new(key: :required_approving_review_count,
+                                       description: 'If not nil, change the number of approving reviews required to merge the PR. ' \
+                                       + 'Acceptable values are `nil` (do not change), 0 (disable) or a number between 1–6',
+                                       optional: true,
+                                       default_value: nil,
+                                       type: Integer),
+          FastlaneCore::ConfigItem.new(key: :enforce_admins,
+                                       description: 'If provided, will update the setting of whether admins can bypass restrictions (false) or not (true)',
+                                       optional: true,
+                                       default_value: nil,
+                                       type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :allow_force_pushes,
+                                       description: 'If provided, will update the setting of whether to allow force pushes on the branch',
+                                       optional: true,
+                                       default_value: nil,
+                                       type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :lock_branch,
+                                       description: 'If provided, will update the locked (aka readonly) state of the branch',
+                                       optional: true,
+                                       default_value: nil,
+                                       type: Boolean),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
+        ]
+      end
+
+      def self.authors
+        ['Automattic']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+
+    # For backwards compatibility
+    class SetbranchprotectionAction < SetBranchProtectionAction
+      def self.category
+        :deprecated
+      end
+
+      def self.deprecated_notes
+        "This action has been renamed `#{superclass.action_name}`"
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_update_release_notes.rb

@@ -8,6 +8,8 @@ module Fastlane
         require_relative '../../helper/release_notes_helper'
         require_relative '../../helper/git_helper'
 
+        UI.deprecated('The `PROJECT_ROOT_FOLDER` environment variable is deprecated and will be removed in a future release. Please pass a path to the `release_notes_file_path` param instead.') unless ENV['PROJECT_ROOT_FOLDER'].nil?
+
         path = params[:release_notes_file_path]
         next_version = Fastlane::Helper::Ios::VersionHelper.calc_next_release_version(params[:new_version])
 

data/lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_git_helper.rb

@@ -12,17 +12,16 @@ module Fastlane
         # @env PROJECT_ROOT_FOLDER The path to the git root of the project
         # @env PROJECT_NAME The name of the directory containing the project code (especially containing the `build.gradle` file)
         #
-        def self.commit_version_bump
-          require_relative './android_version_helper'
-          if File.exist?(Fastlane::Helper::Android::VersionHelper.version_properties_file)
-            Fastlane::Helper::GitHelper.commit(
-              message: 'Bump version number',
-              files: File.join(ENV['PROJECT_ROOT_FOLDER'], 'version.properties')
+        def self.commit_version_bump(build_gradle_path:, version_properties_path:)
+          if File.exist?(version_properties_path)
+            git_commit(
+              path: version_properties_path,
+              message: 'Bump version number'
             )
           else
-            Fastlane::Helper::GitHelper.commit(
-              message: 'Bump version number',
-              files: File.join(ENV['PROJECT_ROOT_FOLDER'], ENV['PROJECT_NAME'], 'build.gradle')
+            git_commit(
+              path: build_gradle_path,
+              message: 'Bump version number'
             )
           end
         end