fastlane-plugin-wpmreleasetoolkit 12.2.0 → 12.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5efb1f6f88d1bb1617313112768ef93497cabe3897bb4834c5026a4e9a68ced0
-  data.tar.gz: 8eaef85d47b2ec7be3e2da0693856923c02e6f67b65707e4143d7241147a7435
+  metadata.gz: bd7622da309b11a1d3f03e67692147361bc620cd3b9ecb0fa6d9b923cd5e8c15
+  data.tar.gz: 662c4964c041947dd71506cee2aeb6c01bfaf2ae35281ff41192ab1231c82201
 SHA512:
-  metadata.gz: 7c05b2af7ca941a5afb52b703f3f0ee315e0ab48ffa87de88c48c5f22bbc1db82f0a819c7e4f2b10e754b6558569d801431e64b00f491e282eadd9885c4f75ac
-  data.tar.gz: fc832aaf5f31e2e6b3f51c268f38529f056dc40a0971fb67e962da313634e2c56580eeac23f8d2e94f2f3dcc74ad3d69b0a465724afb7c178501103a5c01d309
+  metadata.gz: 891584b03637c76ea99ef7843db8639a8154565efd90e9339167f8edf40d7e24fc53c371c42f8e0de06f32fb6050010288b367920b326d9c34beec60d78fb9b4
+  data.tar.gz: 3e8d0bc1db3db2e76c64ed79285113d63fdad4ffcd08cc7444c741aedf62611a194c47f73ea0c35246320855e5cc3e77e302fbf789c86f3de0378adb4682261e

data/README.md

@@ -24,15 +24,17 @@ This guide also includes some tips about configuring your environment and IDE (e
 
 When you need to do a new release of the `release-toolkit`, simply run `rake new_release` and follow the instructions.
 
+> [!NOTE]  
 > This task will:
 >  - Show you the CHANGELOG/release notes it's about to use for that version
 >  - Deduce which version number to use according to [SemVer](https://semver.org/) rules, and ask you to confirm that version number
 >  - Create a `release/<x.y>` branch, update the version number in all the right places, and create a PR for those changes
 
-Submit the PR, adding the `Releases` label to it and adding the `owl-team` as reviewers.
+Submit the PR, adding the `Releases` label to it and adding the `@wordpress-mobile/apps-infrastructure` team as reviewers.
 
 Once that PR is approved and merged, create a new GitHub Release, copy/pasting the CHANGELOG entries for that GH release's description.
 
+> [!IMPORTANT]  
 > Publishing the GitHub Release will create the associated tag as well, which will trigger the CI job that will ultimately `gem push` the gem on RubyGems.
 
 ## Security
@@ -50,4 +52,4 @@ If you have questions about getting setup or just want to say hi, join the [Word
 
 ## License
 
-Mobile Release Toolkit is an Open Source project covered by the [GNU General Public License version 2](LICENSE).
+Mobile Release Toolkit is an Open Source project covered by the [GNU General Public License version 2](LICENSE).

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

@@ -1,17 +1,20 @@
 module Fastlane
   module Actions
     class BuildkitePipelineUploadAction < Action
-      DEFAULT_ENV_FILE = File.join('.buildkite', 'shared-pipeline-vars').freeze
+      DEFAULT_BUILDKITE_PIPELINE_FOLDER = '.buildkite'.freeze
+      DEFAULT_ENV_FILE = File.join(DEFAULT_BUILDKITE_PIPELINE_FOLDER, 'shared-pipeline-vars').freeze
 
       def self.run(params)
         pipeline_file = params[:pipeline_file]
+        pipeline_file = File.join(DEFAULT_BUILDKITE_PIPELINE_FOLDER, pipeline_file) unless File.absolute_path?(pipeline_file)
         env_file = params[:env_file]
-        environment = params[:environment]
+        # Both keys and values need to be passed as strings otherwise Fastlane.sh will fail to parse the command.
+        environment = params[:environment].to_h { |k, v| [k.to_s, v.to_s] }
 
         UI.user_error!("Pipeline file not found: #{pipeline_file}") unless File.exist?(pipeline_file)
         UI.user_error!('This action can only be called from a Buildkite CI build') unless ENV['BUILDKITE'] == 'true'
 
-        UI.message "Adding steps from `#{pipeline_file}` to the current build"
+        UI.message("Adding steps from `#{pipeline_file}` to the current build")
 
         if env_file && File.exist?(env_file)
           UI.message(" - Sourcing environment file beforehand: #{env_file}")
@@ -31,7 +34,7 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(
             key: :pipeline_file,
-            description: 'The path to the YAML pipeline file to upload',
+            description: 'The path to the YAML pipeline file to upload. If a relative path is provided, it will be prefixed with the `.buildkite/` folder path. Absolute paths are used as-is',
             optional: false,
             type: String
           ),

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

@@ -89,23 +89,33 @@ module Fastlane
       # @return [String] The URL of the created Pull Request, or `nil` if no PR was created.
       #
       def self.create_backmerge_pr(token:, repository:, title:, head_branch:, base_branch:, labels:, milestone:, reviewers:, team_reviewers:, intermediate_branch_created_callback:)
-        intermediate_branch = "merge/#{head_branch.gsub('/', '-')}-into-#{base_branch.gsub('/', '-')}"
-
-        if Fastlane::Helper::GitHelper.branch_exists_on_remote?(branch_name: intermediate_branch)
-          UI.user_error!("The intermediate branch `#{intermediate_branch}` already exists. Please check if there is an existing Pull Request that needs to be merged or closed first, or delete the branch.")
+        # Do an early pre-check to see if the PR would be valid, but only if no callback (as a callback might add new commits on intermediate branch)
+        if intermediate_branch_created_callback.nil? && !can_merge?(head_branch, into: base_branch)
+          UI.error("Nothing to merge from #{head_branch} into #{base_branch}. Skipping PR creation.")
           return nil
         end
 
+        # Create the intermediate branch
+        intermediate_branch = "merge/#{head_branch.gsub('/', '-')}-into-#{base_branch.gsub('/', '-')}"
+        if Fastlane::Helper::GitHelper.branch_exists_on_remote?(branch_name: intermediate_branch)
+          UI.important("An intermediate branch `#{intermediate_branch}` already exists on the remote. It will be deleted and GitHub will close any associated existing PR.")
+          Fastlane::Helper::GitHelper.delete_remote_branch_if_exists!(intermediate_branch)
+        end
+        Fastlane::Helper::GitHelper.delete_local_branch_if_exists!(intermediate_branch)
         Fastlane::Helper::GitHelper.create_branch(intermediate_branch)
 
-        intermediate_branch_created_callback&.call(base_branch, intermediate_branch)
-
-        # if there's a callback, make sure it didn't switch branches
-        other_action.ensure_git_branch(branch: "^#{intermediate_branch}/") unless intermediate_branch_created_callback.nil?
-
-        if Fastlane::Helper::GitHelper.point_to_same_commit?(base_branch, head_branch)
-          UI.error("No differences between #{head_branch} and #{base_branch}. Skipping PR creation.")
-          return nil
+        # Call the callback if one was provided to allow the use to add commits on the intermediate branch (e.g. solve conflicts)
+        unless intermediate_branch_created_callback.nil?
+          intermediate_branch_created_callback.call(base_branch, intermediate_branch)
+          # Make sure the callback block didn't switch branches
+          other_action.ensure_git_branch(branch: "^#{intermediate_branch}$")
+
+          # When a callback was provided, do the pre-check about valid PR _only_ at that point, in case the callback added new commits
+          unless can_merge?(intermediate_branch, into: base_branch)
+            UI.error("Nothing to merge from #{intermediate_branch} into #{base_branch}. Skipping PR creation.")
+            Fastlane::Helper::GitHelper.delete_local_branch_if_exists!(intermediate_branch)
+            return nil
+          end
         end
 
         other_action.push_to_git_remote(tags: false)
@@ -137,6 +147,23 @@ module Fastlane
         )
       end
 
+      # Determine if a `head->base` PR would be considered valid by GitHub.
+      #
+      # Note that a PR with an empty diff can still be valid (e.g. if you merge a commit and its revert)
+      #
+      # This method returns false mostly when all commits from `head` has already been merged into `base`
+      # and that there are no new commits to merge (in which case GitHub would refuse creating the PR)
+      #
+      # @param head [String] the head reference (commit sha or branch name) we want to merge
+      # @param into [String] the base reference (commit sha or branch name) we want to merge into
+      # @return [Boolean] true if there are commits in `head` that are not yet in `base` and a merge can happen;
+      #                   false if all commits from `head` are already in `base` and a merge would be rejected
+      #
+      def self.can_merge?(head, into:)
+        merge_base = Fastlane::Helper::GitHelper.find_merge_base(into, head)
+        !Fastlane::Helper::GitHelper.point_to_same_commit?(merge_base, head)
+      end
+
       def self.description
         'Creates backmerge PRs for a release branch into target branches'
       end
@@ -200,7 +227,9 @@ module Fastlane
                                        optional: true,
                                        type: Array),
           FastlaneCore::ConfigItem.new(key: :intermediate_branch_created_callback,
-                                       description: 'Callback to allow for the caller to perform operations on the intermediate branch before pushing. The call back receives two parameters: the base (target) branch for the PR and the intermediate branch name',
+                                       description: 'Callback to allow for the caller to perform operations on the intermediate branch (e.g. pushing new commits to pre-solve conflicts) before creating the PR. ' \
+                                        + 'The callback receives two parameters: the base (target) branch for the PR and the intermediate branch name that has been created.' \
+                                        + 'Note that if you use the callback to add new commits to the intermediate branch, you are responsible for git-pushing them too',
                                        optional: true,
                                        type: Proc),
           Fastlane::Helper::GithubHelper.github_token_config_item,

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

@@ -113,11 +113,19 @@ module Fastlane
 
       # Get the SHA of a given git ref. Typically useful to get the SHA of the current HEAD commit.
       #
-      # @param [String] ref The git ref (commit, branch name, 'HEAD', …) to resolve as a SHA
+      # @param ref [String]
+      #        The git ref (commit, branch name, 'HEAD', …) to resolve as a SHA
+      # @param prepend_origin_if_needed [Boolean]
+      #        If true, will retry the rev-parse by prefixing `origin/` to the ref it it failed without it
       # @return [String] The commit SHA of the ref
       #
-      def self.get_commit_sha(ref: 'HEAD')
-        Git.open(Dir.pwd).revparse(ref)
+      def self.get_commit_sha(ref: 'HEAD', prepend_origin_if_needed: false)
+        repo = Git.open(Dir.pwd)
+        repo.revparse(ref)
+      rescue Git::FailedError
+        raise unless prepend_origin_if_needed
+
+        repo.revparse("origin/#{ref}")
       end
 
       # Creates a tag for the given version, and optionally push it to the remote.
@@ -170,28 +178,36 @@ module Fastlane
         Action.sh('git', 'fetch', '--tags')
       end
 
+      # Use `git merge-base` to find as good a common ancestors as possible for a merge
+      #
+      # @param ref1 [String] The first git reference (sha1, ref name…)to find the common ancestor of
+      # @param ref2 [String] The second git reference (sha1, ref name…)to find the common ancestor of
+      # @return [String] The merge-base aka common ancestor for the 2 commits provided
+      # @note If a reference (e.g. branch name) can't be found locally, it will try with the same ref prefixed with `origin/`
+      #
+      def self.find_merge_base(ref1, ref2)
+        git_repo = Git.open(Dir.pwd)
+        # Resolve to shas, mostly so that we can support cases with and without `origin/` explicit prefix on branch names
+        ref1_sha, ref2_sha = [ref1, ref2].map { |ref| get_commit_sha(ref: ref, prepend_origin_if_needed: true) }
+
+        git_repo.merge_base(ref1_sha, ref2_sha)&.first&.sha
+      end
+
       # Checks if two git references point to the same commit.
       #
       # @param ref1 [String] the first git reference to check.
       # @param ref2 [String] the second git reference to check.
-      # @param remote_name [String] the name of the remote repository to use (default is 'origin').
-      #                             If nil or empty, no remote prefix will be used.
       #
       # @return [Boolean] true if the two references point to the same commit, false otherwise.
       #
-      def self.point_to_same_commit?(ref1, ref2, remote_name: 'origin')
-        git_repo = Git.open(Dir.pwd)
-
-        ref1_full = remote_name.to_s.empty? ? ref1 : "#{remote_name}/#{ref1}"
-        ref2_full = remote_name.to_s.empty? ? ref2 : "#{remote_name}/#{ref2}"
+      def self.point_to_same_commit?(ref1, ref2)
         begin
-          ref1_commit = git_repo.gcommit(ref1_full)
-          ref2_commit = git_repo.gcommit(ref2_full)
+          ref1_sha = get_commit_sha(ref: ref1, prepend_origin_if_needed: true)
+          ref2_sha = get_commit_sha(ref: ref2, prepend_origin_if_needed: true)
         rescue StandardError => e
-          UI.error "Error fetching commits for #{ref1_full} and #{ref2_full}: #{e.message}"
-          return false
+          UI.user_error! "Error fetching commits for #{ref1} and/or #{ref2}: #{e.message}"
         end
-        ref1_commit.sha == ref2_commit.sha
+        ref1_sha == ref2_sha
       end
 
       # Returns the current git branch, or "HEAD" if it's not checked out to any branch
@@ -232,6 +248,32 @@ module Fastlane
         !Action.sh('git', 'ls-remote', '--heads', remote_name, branch_name).empty?
       end
 
+      # Delete a local branch if it exists.
+      #
+      # @param [String] branch_name The name of the local branch to delete.
+      # @return [Boolean] true if the branch was deleted, false if not (e.g. no such local branch existed in the first place)
+      #
+      def self.delete_local_branch_if_exists!(branch_name)
+        git_repo = Git.open(Dir.pwd)
+        return false unless git_repo.is_local_branch?(branch_name)
+
+        git_repo.branch(branch_name).delete
+        true
+      end
+
+      # Delete a remote branch if it exists.
+      #
+      # @param [String] branch_name The name of the remote branch to delete.
+      # @param [String] remote_name The name of the remote to delete the branch from. Defaults to 'origin'
+      # @return [Boolean] true if the branch was deleted, false if not (e.g. no such local branch existed in the first place)
+      #
+      def self.delete_remote_branch_if_exists!(branch_name, remote_name: 'origin')
+        git_repo = Git.open(Dir.pwd)
+        return false unless git_repo.branches.any? { |b| b.remote&.name == remote_name && b.name == branch_name }
+
+        git_repo.push(remote_name, branch_name, delete: true)
+      end
+
       # Checks whether a given path is ignored by Git, relying on Git's `check-ignore` under the hood.
       #
       # @param [String] path The path to check against `.gitignore`

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

@@ -2,6 +2,6 @@
 
 module Fastlane
   module Wpmreleasetoolkit
-    VERSION = '12.2.0'
+    VERSION = '12.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-wpmreleasetoolkit
 version: !ruby/object:Gem::Version
-  version: 12.2.0
+  version: 12.3.0
 platform: ruby
 authors:
 - Automattic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport