GithubHelper#create_milestone: Rename parameters to be more descriptive

Author: raafaelima

lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_new_milestone_action.rb

@@ -11,20 +11,26 @@ def self.run(params)
 
         github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
         last_stone = github_helper.get_last_milestone(repository)
+
         UI.message("Last detected milestone: #{last_stone[:title]} due on #{last_stone[:due_on]}.")
+
         milestone_duedate = last_stone[:due_on]
         milestone_duration = params[:milestone_duration]
         newmilestone_duedate = (milestone_duedate.to_datetime.next_day(milestone_duration).to_time).utc
         newmilestone_number = Fastlane::Helper::Ios::VersionHelper.calc_next_release_version(last_stone[:title])
         number_of_days_from_code_freeze_to_release = params[:number_of_days_from_code_freeze_to_release]
+        # If there is a review process, we want to submit the binary 3 days before its release
+        # Using 3 days is mostly for historical reasons where we release the apps on Monday and submit them on Friday.
+        days_until_submission = params[:need_appstore_submission] ? (number_of_days_from_code_freeze_to_release - 3) : milestone_duration
+
         UI.message("Next milestone: #{newmilestone_number} due on #{newmilestone_duedate}.")
+
         github_helper.create_milestone(
           repository: repository,
-          newmilestone_number: newmilestone_number,
-          newmilestone_duedate: newmilestone_duedate,
-          newmilestone_duration: milestone_duration,
-          number_of_days_from_code_freeze_to_release: number_of_days_from_code_freeze_to_release,
-          need_submission: params[:need_appstore_submission]
+          title: newmilestone_number,
+          due_date: newmilestone_duedate,
+          days_until_submission: days_until_submission,
+          days_until_release: number_of_days_from_code_freeze_to_release
         )
       end
 

lib/fastlane/plugin/wpmreleasetoolkit/helper/github_helper.rb

@@ -74,23 +74,16 @@ def get_last_milestone(repository)
       # Creates a new milestone
       #
       # @param [String] repository The repository name, including the organization (e.g. `wordpress-mobile/wordpress-ios`)
-      # @param [String] newmilestone_number The name of the milestone we want to create (e.g.: `16.9`)
-      # @param [Time] newmilestone_duedate milestone due date (e.g. `2022-10-22T12:00:00Z`)
-      # @param [Integer] newmilestone_duration Number of days that a milestone extents
-      # @param [Integer] number_of_days_from_code_freeze_to_release Number of days from code freeze to release
-      # @param [Boolean] need_submission The app needs to be submitted?
-      #  if `true`, will subtract 3 days from the `:number_of_days_from_code_freeze_to_release`.
-      #  if `false`, will use the days of `:newmilestone_duration`
-      #
-      def create_milestone(repository:, newmilestone_number:, newmilestone_duedate:, newmilestone_duration:, number_of_days_from_code_freeze_to_release:, need_submission:)
-        # If there is a review process, we want to submit the binary 3 days before its release
-        #
-        # Using 3 days is mostly for historical reasons where we release the apps on Monday and submit them on Friday.
-        days_until_submission = need_submission ? (number_of_days_from_code_freeze_to_release - 3) : newmilestone_duration
-        submission_date = newmilestone_duedate.to_datetime.next_day(days_until_submission)
-        release_date = newmilestone_duedate.to_datetime.next_day(number_of_days_from_code_freeze_to_release)
+      # @param [String] title The name of the milestone we want to create (e.g.: `16.9`)
+      # @param [Time] due_date milestone due date (e.g. `2022-10-22T12:00:00Z`)
+      # @param [Integer] days_until_submission Number of days until submission
+      # @param [Integer] days_until_release Number of days from code freeze to release
+      #
+      def create_milestone(repository:, title:, due_date:, days_until_submission:, days_until_release:)
+        submission_date = due_date.to_datetime.next_day(days_until_submission)
+        release_date = due_date.to_datetime.next_day(days_until_release)
         comment = <<~MILESTONE_DESCRIPTION
-          Code freeze: #{newmilestone_duedate.to_datetime.strftime('%B %d, %Y')}
+          Code freeze: #{due_date.to_datetime.strftime('%B %d, %Y')}
           App Store submission: #{submission_date.strftime('%B %d, %Y')}
           Release: #{release_date.strftime('%B %d, %Y')}
         MILESTONE_DESCRIPTION
@@ -107,9 +100,9 @@ def create_milestone(repository:, newmilestone_number:, newmilestone_duedate:, n
         #
         # This is a bug in the GitHub API, not in our date computation logic.
         # To solve this, we trick it by forcing the time component of the ISO date we send to be `12:00:00Z`.
-        options[:due_on] = newmilestone_duedate.strftime('%Y-%m-%dT12:00:00Z')
+        options[:due_on] = due_date.strftime('%Y-%m-%dT12:00:00Z')
         options[:description] = comment
-        client.create_milestone(repository, newmilestone_number, options)
+        client.create_milestone(repository, title, options)
       end
 
       # Creates a Release on GitHub as a Draft

spec/github_helper_spec.rb

@@ -234,14 +234,14 @@ def get_milestone(milestone_name:)
     end
 
     def create_milestone(need_submission:, milestone_duration:, days_code_freeze:)
+      days_until_submission = need_submission ? (days_code_freeze - 3) : milestone_duration
       helper = described_class.new(github_token: 'Fake-GitHubToken-123')
       helper.create_milestone(
         repository: test_repo,
-        newmilestone_number: test_milestone_number,
-        newmilestone_duedate: test_milestone_duedate.to_time.utc,
-        newmilestone_duration: milestone_duration,
-        number_of_days_from_code_freeze_to_release: days_code_freeze,
-        need_submission: need_submission
+        title: test_milestone_number,
+        due_date: test_milestone_duedate.to_time.utc,
+        days_until_submission: days_until_submission,
+        days_until_release: days_code_freeze
       )
     end
   end