multi_repo 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc809429c529e0f58d2274708e0785944edf7170ce7aa23858fc88031bb593e1
-  data.tar.gz: 7d58ebc46fe2202b9e2e285e6a26fc4b4a40556181301a651994d41b9e4c1d5f
+  metadata.gz: 8505baba7399c81174faea1dcce56eb3d16687d1c08c88ac1fe18c2eeae6f26a
+  data.tar.gz: d513358adc717ca4582c6f29864926a0a23bfb01a88a0622b55ff358939f7d35
 SHA512:
-  metadata.gz: 4828418ee29894ce72fd5d2ab2e705b99854f1aa5ba26f321a0235bfa7c7eadf45a5aada881897aa5df16fb6f83cdd1968113af80e0163d2a13a9e4dd354ee2d
-  data.tar.gz: b4b2ed2d3c9677e658ad4c60ec615779882dee381bc5ed4b771602d56ca0a5b72ade124e140d50568a359c5e838d99ce3c51a8a475925a096d0582b7adc0cf9e
+  metadata.gz: 86f552f73954d01bbf06b31906170399eee68a60721538743dd5fdf2ce46832e918c89740d49e83c337a150f52dc9f8be3f73d0cb37f459fab3dcf317e244366
+  data.tar.gz: 86846ee0c472f5eb5b8ebade9bdafa87985db8ab114e210b6b0aa276e36466a56412260a6e503cc436dc874893f13baa140733542088816bae034c40ce7e3e5d

data/.github/workflows/ci.yaml

@@ -14,6 +14,8 @@ jobs:
         ruby-version:
         - '3.0'
         - '3.1'
+        - '3.2'
+        - '3.3'
     env:
       CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
     steps:
@@ -29,4 +31,4 @@ jobs:
     - name: Report code coverage
       if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '3.1' }}
       continue-on-error: true
-      uses: paambaati/codeclimate-action@v5
+      uses: paambaati/codeclimate-action@v9

data/CHANGELOG.md

@@ -4,6 +4,21 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.5.0] - 2024-11-12
+### Added
+- [pull_request_labeler] Add ability to also add a comment about why the labels are changing [[#30](https://github.com/ManageIQ/multi_repo/pull/30)]
+- [pull_request_labeler] Add normalization of PR formats to org/repo#pr format [[#30](https://github.com/ManageIQ/multi_repo/pull/30)]
+- [pull_request_merger] Add URL support to pull_request_merger [[#37](https://github.com/ManageIQ/multi_repo/pull/37)]
+- [Git Service, GitHub service] Move helper methods into services [[#31](https://github.com/ManageIQ/multi_repo/pull/31)]
+- Add testing with ruby 3.2, 3.3 [[#35](https://github.com/ManageIQ/multi_repo/pull/35)]
+
+### Changed
+- [pull_request_labeler] Make add and remove optional [[#30](https://github.com/ManageIQ/multi_repo/pull/30)]
+
+### Fixed
+- [pull_request_labeler] Fix cli description of --prs [[#30](https://github.com/ManageIQ/multi_repo/pull/30)]
+- [show_commit_history] Handle issue where PR may not be found [[#36](https://github.com/ManageIQ/multi_repo/pull/30)]
+
 ## [0.4.0] - 2024-03-29
 ### Changed
 - Allow overriding the path for a repo [[#28](https://github.com/ManageIQ/multi_repo/pull/28)]
@@ -18,6 +33,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - [show_commit_history] Prevent missing ranges from failing the entire run [[#20](https://github.com/ManageIQ/multi_repo/pull/20)]
 - [pull_request_merger] Fixing issue passing kwargs on Ruby 3 [[#23](https://github.com/ManageIQ/multi_repo/pull/23)]
 
-[Unreleased]: https://github.com/ManageIQ/more_core_extensions/compare/v0.4.0...HEAD
+[Unreleased]: https://github.com/ManageIQ/more_core_extensions/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/ManageIQ/more_core_extensions/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/ManageIQ/more_core_extensions/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/ManageIQ/more_core_extensions/compare/v0.3.0...v0.3.1

data/lib/multi_repo/service/git.rb

@@ -83,6 +83,17 @@ module MultiRepo::Service
       true
     end
 
+    def destroy_remote(remote)
+      if dry_run
+        puts "** dry-run: git remote rm #{remote}".light_black
+      else
+        client.remote("rm", remote)
+      end
+    rescue MiniGit::GitError
+      # Ignore missing remotes because we want them destroyed anyway
+      nil
+    end
+
     def remote_branch?(remote, branch)
       client.capturing.ls_remote(remote, branch).present?
     end

data/lib/multi_repo/service/github.rb

@@ -83,6 +83,24 @@ module MultiRepo::Service
       client.workflows(repo_name)[:workflows].select { |w| w.state == "disabled_inactivity" }
     end
 
+    PR_REGEX = %r{^([^/#]+/[^/#]+)#(\d+)$}
+
+    # Parse a list of PRs that are in URL or org/repo#pr format into a Array of
+    # [repo_name, pr_number] entries.
+    def self.parse_prs(*prs)
+      prs.flatten.map do |pr|
+        # Normalize to org/repo#pr
+        normalized_pr = pr.sub("https://github.com/", "").sub("/pull/", "#")
+
+        if (match = PR_REGEX.match(normalized_pr))
+          repo_name, pr_number = match.captures
+          [repo_name, pr_number.to_i]
+        else
+          raise ArgumentError, "Invalid PR '#{pr}'. PR must be a GitHub URL or in org/repo#pr format."
+        end
+      end
+    end
+
     attr_reader :dry_run
 
     def initialize(dry_run: false)
@@ -138,6 +156,44 @@ module MultiRepo::Service
       end
     end
 
+    def add_labels_to_an_issue(repo_name, issue_number, labels)
+      labels = Array(labels)
+      if dry_run
+        puts "** dry-run: github.add_labels_to_an_issue(#{repo_name.inspect}, #{issue_number.inspect}, #{labels.inspect})".light_black
+      else
+        client.add_labels_to_an_issue(repo_name, issue_number, labels)
+      end
+    end
+
+    def remove_labels_from_an_issue(repo_name, issue_number, labels)
+      Array(labels).each do |label|
+        if dry_run
+          puts "** dry-run: github.remove_label(#{repo_name.inspect}, #{issue_number.inspect}, #{label.inspect})".light_black
+        else
+          client.remove_label(repo_name, issue_number, label)
+        end
+      rescue Octokit::NotFound
+        # Ignore labels that are not found, because we want them removed anyway
+      end
+    end
+
+    def add_comment(repo_name, issue_number, body)
+      if dry_run
+        puts "** dry-run: github.add_comment(#{repo_name.inspect}, #{issue_number.inspect}, #{body.pretty_inspect.chomp})".light_black
+      else
+        client.add_comment(repo_name, issue_number, body)
+      end
+    end
+
+    def assign_user(repo_name, issue_number, assignee)
+      assignee = assignee[1..] if assignee.start_with?("@")
+      if dry_run
+        puts "** dry-run: github.update_issue(#{repo_name.inspect}, #{issue_number.inspect}, \"assignee\" => #{assignee.inspect})".light_black
+      else
+        client.update_issue(repo_name, issue_number, "assignee" => assignee)
+      end
+    end
+
     def create_milestone(repo_name, title, due_on)
       if dry_run
         puts "** dry-run: github.create_milestone(#{repo_name.inspect}, #{title.inspect}, :due_on => #{due_on.strftime("%Y-%m-%d").inspect})".light_black
@@ -208,6 +264,14 @@ module MultiRepo::Service
       end
     end
 
+    def merge_pull_request(repo_name, pr_number)
+      if dry_run
+        puts "** dry-run: github.merge_pull_request(#{repo_name.inspect}, #{pr_number.inspect})".light_black
+      else
+        client.merge_pull_request(repo_name, pr_number)
+      end
+    end
+
     def create_or_update_repository_secret(repo_name, key, value)
       payload = encode_secret(repo_name, value)
 

data/lib/multi_repo/version.rb

@@ -1,3 +1,3 @@
 module MultiRepo
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.0".freeze
 end

data/scripts/destroy_remote

@@ -20,9 +20,5 @@ MultiRepo::CLI.each_repo(**opts) do |repo|
     next
   end
 
-  if opts[:dry_run]
-    puts "** dry-run: git remote rm #{opts[:remote]}".light_black
-  else
-    repo.git.client.remote("rm", opts[:remote])
-  end
+  repo.git.destroy_remote(opts[:remote])
 end

data/scripts/pull_request_labeler

@@ -9,53 +9,32 @@ end
 opts = Optimist.options do
   synopsis "Add or remove labels on a set of pull requests."
 
-  opt :prs,    "The list of PRs to merge", :type => :strings, :required => true
-  opt :add,    "Labels to add",            :type => :strings, :required => true
-  opt :remove, "Labels to remove",         :type => :strings, :required => true
+  opt :prs,    "The list of PRs to label", :type => :strings, :required => true
+  opt :add,    "Labels to add",            :type => :strings
+  opt :remove, "Labels to remove",         :type => :strings
 
-  MultiRepo::CLI.common_options(self, :only => :dry_run)
-end
-
-# TODO: Normalize any PR format to `org/repo#pr`
-PR_REGEX = %r{^([^/#]+/[^/#]+)#([^/#]+)$}
-Optimist.die :prs, "must be in the form `org/repo#pr`" unless opts[:prs].all? { |pr| pr.match?(PR_REGEX) }
-
-def github
-  MultiRepo::Service::Github.client
-end
+  opt :comment, "Comment explaining the label change", :type => :string
 
-def add_labels(repo_name, pr_number, labels:, dry_run:, **_)
-  labels = Array(labels)
-  if dry_run
-    puts "** dry-run: github.add_labels_to_an_issue(#{repo_name.inspect}, #{pr_number.inspect}, #{labels.inspect})".light_black
-  else
-    github.add_labels_to_an_issue(repo_name, pr_number, labels)
-  end
+  MultiRepo::CLI.common_options(self, :only => :dry_run)
 end
 
-def remove_labels(repo_name, pr_number, labels:, dry_run:, **_)
-  Array(labels).each do |label|
-    remove_label(repo_name, pr_number, label: label, dry_run: dry_run)
-  end
-end
+Optimist.die "at least one of --add or --remove is required" unless opts[:add_given] || opts[:remove_given]
 
-def remove_label(repo_name, pr_number, label:, dry_run:, **_)
-  if dry_run
-    puts "** dry-run: github.remove_label(#{repo_name.inspect}, #{pr_number.inspect}, #{label.inspect})".light_black
-  else
-    github.remove_label(repo_name, pr_number, label)
+prs =
+  begin
+    MultiRepo::Service::Github.parse_prs(opts[:prs])
+  rescue ArgumentError => err
+    Optimist.die :prs, err.message
   end
-rescue Octokit::NotFound
-  # Ignore labels that are not found, because we want them removed anyway
-end
 
-opts[:prs].each do |pr|
-  puts MultiRepo::CLI.header(pr)
+github = MultiRepo::Service::Github.new(:dry_run => opts[:dry_run])
 
-  repo_name, pr_number = PR_REGEX.match(pr).captures
+prs.each do |repo_name, pr_number|
+  puts MultiRepo::CLI.header("#{repo_name}##{pr_number}")
 
-  add_labels(repo_name, pr_number, labels: opts[:add], **opts)
-  remove_labels(repo_name, pr_number, labels: opts[:remove], **opts)
+  github.add_labels_to_an_issue(repo_name, pr_number, opts[:add]) if opts[:add].present?
+  github.remove_labels_from_an_issue(repo_name, pr_number, opts[:remove]) if opts[:remove].present?
+  github.add_comment(repo_name, pr_number, opts[:comment]) if opts[:comment].present?
 
   puts
 end

data/scripts/pull_request_merger

@@ -16,50 +16,28 @@ opts = Optimist.options do
   MultiRepo::CLI.common_options(self)
 end
 
-# TODO: Normalize any PR format to `org/repo#pr`
-PR_REGEX = %r{^([^/#]+/[^/#]+)#([^/#]+)$}
-Optimist.die :prs, "must be in the form `org/repo#pr`" unless opts[:prs].all? { |pr| pr.match?(PR_REGEX) }
-
-def merge_pull_request(repo_name, pr_number, dry_run:, **_)
-  if dry_run
-    puts "** dry-run: github.merge_pull_request(#{repo_name.inspect}, #{pr_number.inspect})".light_black
-  else
-    begin
-      MultiRepo::Service::Github.client.merge_pull_request(repo_name, pr_number)
-    rescue Octokit::MethodNotAllowed => err
-      raise unless err.to_s.include?("Pull Request is not mergeable")
-
-      puts "** WARN: Pull Request is not mergeable"
-    end
+prs =
+  begin
+    MultiRepo::Service::Github.parse_prs(opts[:prs])
+  rescue ArgumentError => err
+    Optimist.die :prs, err.message
   end
-end
 
-def add_labels(repo_name, pr_number, labels:, dry_run:, **_)
-  labels = Array(labels)
-  if dry_run
-    puts "** dry-run: github.add_labels_to_an_issue(#{repo_name.inspect}, #{pr_number.inspect}, #{labels.inspect})".light_black
-  else
-    MultiRepo::Service::Github.client.add_labels_to_an_issue(repo_name, pr_number, labels)
-  end
-end
+github = MultiRepo::Service::Github.new(:dry_run => opts[:dry_run])
 
-def assign_user(repo_name, pr_number, assignee:, dry_run:, **_)
-  assignee = assignee[1..] if assignee.start_with?("@")
-  if dry_run
-    puts "** dry-run: github.update_issue(#{repo_name.inspect}, #{pr_number.inspect}, \"assignee\" => #{assignee.inspect})".light_black
-  else
-    MultiRepo::Service::Github.client.update_issue(repo_name, pr_number, "assignee" => assignee)
-  end
-end
+prs.each do |repo_name, pr_number|
+  puts MultiRepo::CLI.header("#{repo_name}##{pr_number}")
 
-opts[:prs].each do |pr|
-  puts MultiRepo::CLI.header(pr)
+  begin
+    github.merge_pull_request(repo_name, pr_number)
+  rescue Octokit::MethodNotAllowed => err
+    raise unless err.to_s.include?("Pull Request is not mergeable")
 
-  repo_name, pr_number = PR_REGEX.match(pr).captures
+    puts "** WARN: Pull Request is not mergeable".light_yellow
+  end
 
-  merge_pull_request(repo_name, pr_number, **opts)
-  add_labels(repo_name, pr_number, **opts) if opts[:labels].present?
-  assign_user(repo_name, pr_number, **opts)
+  github.add_labels_to_an_issue(repo_name, pr_number, opts[:labels]) if opts[:labels].present?
+  github.assign_user(repo_name, pr_number, opts[:assignee])
 
   puts
 end

data/scripts/show_commit_history

@@ -60,7 +60,12 @@ MultiRepo::CLI.repos_for(**opts).each do |repo|
     log.lines.each do |line|
       next unless (match = line.match(/Merge pull request #(\d+)\b/))
 
-      pr = github.pull_request(repo.name, match[1])
+      pr =
+        begin
+          github.pull_request(repo.name, match[1])
+        rescue Octokit::NotFound
+          next # PR not found could mean this was a cherry-pick from a different repo, so the PR doesn't exist.
+        end
       label = pr.labels.detect { |l| results.key?(l.name) }&.name || "other"
       results[label] << pr
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_repo
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - ManageIQ Authors
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -360,7 +360,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: MultiRepo is a library for managing multiple repositiories and running scripts