fastlane-plugin-wpmreleasetoolkit 9.3.1 → 9.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adbc7e50db36af4f4a69cb15a8d7ec5b0f006b9632e9027497f38d02e7c8670d
-  data.tar.gz: 18cc86253415b727a3677e47d70d0541c25d38d7fec610d377e292922ad53e2a
+  metadata.gz: bd44032856f74c52c1ddc0ad52169d8c88f8af309a3654e5d3f4aed2bfaee8fc
+  data.tar.gz: af620c26cfe9f8c4c0bbf80d59ef1d3042dbb293eed051592ff94d589fd22074
 SHA512:
-  metadata.gz: 297b158333face55b84e385eb76509377d4d40cf9a908cf90bae25c01024938aacdcf7276d2933b461795021c3fab5d10adecd27ad2869fb152f6fee4bdfad1b
-  data.tar.gz: 293850e7a492026281c7d9234aeb7d751c395a1bfe03c55403bfcdd1cd88d277cca5067e8fbc810c2fd7a1e796a378aaa7b9dff39cd57a8033db6a91c6b9dd21
+  metadata.gz: 44a3e501c71875f0c3e621a5cbc99cc866204ac28777c3ce1745c22f4aafdde179bae6716ab660475624aaab2c682621baf748914695218aeb02f5e242080cbf
+  data.tar.gz: fb19b292f589ee8c63dcc54abc8908bbfe8f73ec3af087ea3d4b8aff91ad7246bb2a92a4e6a04411dd5f56f3b4ba1707012c8d98207ab3c460403086d8b06c96

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

@@ -0,0 +1,104 @@
+require 'fastlane/action'
+require_relative '../../helper/github_helper'
+
+module Fastlane
+  module Actions
+    class UpdatePullRequestsMilestoneAction < Action
+      def self.run(params)
+        repository = params[:repository]
+
+        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
+
+        pr_numbers = params[:pr_numbers]
+        from_milestone = params[:from_milestone]
+        to_milestone = params[:to_milestone]
+        pr_comment = params[:pr_comment]
+
+        target_milestone = nil
+        unless to_milestone.nil?
+          target_milestone = github_helper.get_milestone(repository, to_milestone)
+          UI.user_error!("Unable to find target milestone matching version #{to_milestone}") if target_milestone.nil?
+        end
+
+        prs_nums = if pr_numbers
+                     pr_numbers
+                   elsif from_milestone
+                     # get the milestone object based on title starting text
+                     m = github_helper.get_milestone(repository, from_milestone)
+                     UI.user_error!("Unable to find source milestone matching version #{from_milestone}") if m.nil?
+
+                     # get all open PRs in that milestone
+                     github_helper.get_prs_for_milestone(repository: repository, milestone: m).map(&:number)
+                   else
+                     UI.user_error!('One of `pr_numbers` or `from_milestone` must be provided to indicate which PR(s) to update')
+                   end
+
+        UI.message("Updating milestone of #{prs_nums.count} PRs to `#{target_milestone&.title}`")
+
+        prs_nums.each do |pr_num|
+          github_helper.set_pr_milestone(
+            repository: repository,
+            pr_number: pr_num,
+            milestone: target_milestone
+          )
+          next if pr_comment.nil? || pr_comment.empty?
+
+          github_helper.comment_on_pr(
+            project_slug: repository,
+            pr_number: pr_num,
+            body: pr_comment
+          )
+        end
+      end
+
+      def self.description
+        'Updates the milestone field of PRs'
+      end
+
+      def self.authors
+        ['Automattic']
+      end
+
+      def self.return_value
+        'The PR numbers of all the PRs that were updated with the new milestone'
+      end
+
+      def self.details
+        'Updates the milestone field of a PR, of or all still-opened PRs in a milestone'
+      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: :pr_numbers,
+                                       description: 'The PR numbers to update the milestone of',
+                                       optional: true,
+                                       type: Array,
+                                       conflicting_options: [:from_milestone]),
+          FastlaneCore::ConfigItem.new(key: :from_milestone,
+                                       description: 'The version (milestone title\'s start) for which we want to update all open PRs of to a new milestone',
+                                       optional: true,
+                                       type: String,
+                                       conflicting_options: [:pr_numbers]),
+          FastlaneCore::ConfigItem.new(key: :to_milestone,
+                                       description: 'The version (milestone title\'s start) for the new milestone to assign to the targeted PRs. Pass nil to unset the milestone',
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :pr_comment,
+                                       description: 'If non-nil, the custom comment to leave on each PR whose milestone has been updated',
+                                       optional: true,
+                                       type: String),
+          Fastlane::Helper::GithubHelper.github_token_config_item,
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -25,25 +25,49 @@ module Fastlane
         @client.auto_paginate = true
       end
 
+      # @param [String] repository A GitHub repository slug
+      # @param [String] release The release version to find the milestone for.
+      # @note This relies on the `release` version string being at the start of the milestone's `title`
+      # @return [Sawyer::Resource] A milestone object in a repository, or nil if none matches
+      #
       def get_milestone(repository, release)
-        miles = client.list_milestones(repository)
-        mile = nil
-
-        miles&.each do |mm|
-          mile = mm if mm[:title].start_with?(release)
+        milestones = client.list_milestones(repository)
+        milestones&.reverse&.find do |m|
+          m[:title].start_with?(release)
         end
-
-        return mile
       end
 
       # Fetch all the PRs for a given milestone
       #
       # @param [String] repository The repository name, including the organization (e.g. `wordpress-mobile/wordpress-ios`)
-      # @param [String] milestone The name of the milestone we want to fetch the list of PRs for (e.g.: `16.9`)
-      # @return [<Sawyer::Resource>] A list of the PRs for the given milestone, sorted by number
+      # @param [Sawyer::Resource, String] milestone The milestone object, or title of the milestone, we want to fetch the list of PRs for (e.g.: `16.9`)
+      # @param [Boolean] include_closed If set to true, will include both opened and closed PRs. Otherwise, will only include opened PRs.
+      # @return [Array<Sawyer::Resource>] A list of the PRs for the given milestone, sorted by number
       #
-      def get_prs_for_milestone(repository, milestone)
-        client.search_issues(%(type:pr milestone:"#{milestone}" repo:#{repository}))[:items].sort_by(&:number)
+      def get_prs_for_milestone(repository:, milestone:, include_closed: false)
+        milestone_title = milestone.is_a?(Sawyer::Resource) ? milestone.title : milestone
+        query = %(repo:#{repository} type:pr milestone:"#{milestone_title}")
+        query += ' is:open' unless include_closed
+
+        client.search_issues(query)[:items].sort_by(&:number)
+      end
+
+      # Set/Update the milestone assigned to a given PR or issue
+      #
+      # @param [String] repository The repository name, including the organization (e.g. `wordpress-mobile/wordpress-ios`)
+      # @param [Integer] pr_number The PR (or issue) number to update the milestone of
+      # @param [Sawyer::Resource?, Integer?] milestone The milestone object or number to set on this PR, or nil to unset the milestone
+      # @note Use `get_milestone` to get a milestone object from a version number
+      # @raise [Fastlane::UI::Error] UI.user_error! if PR does not exist or milestone provided is invalid
+      #
+      def set_pr_milestone(repository:, pr_number:, milestone:)
+        milestone_num = milestone.is_a?(Sawyer::Resource) ? milestone.number : milestone
+
+        client.update_issue(repository, pr_number, { milestone: milestone_num })
+      rescue Octokit::NotFound
+        UI.user_error!("Could not find PR ##{pr_number} in #{repository}")
+      rescue Octokit::UnprocessableEntity
+        UI.user_error!("Invalid milestone #{milestone_num}")
       end
 
       def get_last_milestone(repository)

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

@@ -2,6 +2,6 @@
 
 module Fastlane
   module Wpmreleasetoolkit
-    VERSION = '9.3.1'
+    VERSION = '9.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-wpmreleasetoolkit
 version: !ruby/object:Gem::Version
-  version: 9.3.1
+  version: 9.4.0
 platform: ruby
 authors:
 - Automattic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -460,6 +460,7 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/remove_branch_protection_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/set_branch_protection_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/setfrozentag_action.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/actions/common/update_pull_requests_milestone_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/upload_to_s3.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_add_files_to_copy_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_apply_action.rb