decidim-maintainers_toolbox 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98bbc7bc7f2fe89db2430fe013218ed8f73139241148f81e2b836001341a9edb
-  data.tar.gz: b2fcf684927d644818e40a3b47542bc9e71159ff8a220de40f45f7c02d479d90
+  metadata.gz: 28f518a4728ae94af5041c325e6c3814af3e48740d9c3e6cb28c2f3c83a358f2
+  data.tar.gz: 8700cc97ce988b8500e30961bd1d157f435971b5ea726769bd7df25a8d14e09c
 SHA512:
-  metadata.gz: e9fcb49b88f506a3d8522ed38afe5253bb6cbdff6f66287ce9e5d9b24800f37d10756784999b9ef3944c7a338ffb088d0216da9232d2b77f604a36dbb40cb7d9
-  data.tar.gz: 919e40cba79bb9d64c4cdaf6a7ec485423ffb64017f063ea696be0a5249e9d9eafd4bbf68c7cc85ee7aaf2059c3e083a637273e7f8b132953294f1fdc07c6c7b
+  metadata.gz: 953bb3fd9f7d34dc69797e0d40b874c6c6192a3250ec8533d65da67c32767ddff79b3776ba73d96cc29f595073f0234c4766a64205c28826998bb008441c3ae2
+  data.tar.gz: 1da57e99537368d5af2065745b5808888ef7738ebf2faee5d4d282f5217f726fde64fa492b74ceb784c94109cb0bb3135de0460ec8ec6a1d5c65dcb41c84867a

data/README.md

@@ -55,11 +55,10 @@ To release this gem, follow these steps:
 
 1. Bump the version number in `lib/decidim/maintainers_toolbox/version.rb` following [Semantic Versioning](https://semver.org/).
 1. Update the `CHANGELOG.md` with the new version and the changes.
-1. Commit the changes.
-1. Create a new tag with the version number.
-1. Push the changes and the tag to the repository.
-1. Run `rake build` to build the gem.
-1. Run `rake release` to publish the gem to [rubygems.org](https://rubygems.org).
+1. Commit the changes: `git commit -m "Prepare release v0.1.0"`
+1. Create the new tag, push the changs, build and publish with `bundle exec rake release[origin]`
+
+Mind that you will need to have the right permissions to push to the repository and publish the gem.
 
 ## Contributing
 

data/decidim-maintainers_toolbox.gemspec

@@ -37,11 +37,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport", "~> 6.1.7"
   spec.add_dependency "faraday", "~> 1.10"
   spec.add_dependency "ruby-progressbar", "~> 1.7"
   spec.add_dependency "thor", "~> 1.0"
 
-  spec.add_development_dependency "activesupport", "~> 6.1.7"
   spec.add_development_dependency "rspec", "~> 3.12"
   spec.add_development_dependency "webmock", "~> 3.18"
 end

data/exe/decidim-action-backporter

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "thor"
+
+require_relative "../lib/decidim/maintainers_toolbox/github_manager/querier"
+require_relative "../lib/decidim/maintainers_toolbox/action_backporter"
+
+class ActionBackporterCLI < Thor
+  desc "", "Backport a pull request to another branch. This is intended to be run in the GitHub Action environment, for automating the backport processes."
+  option :github_token, required: true, desc: <<~HELP
+    Required. Github Personal Access Token (PAT). It can be obtained from https://github.com/settings/tokens/new. You will need to create one with `public_repo` access.
+    Alternatively, you can use the `gh` CLI tool to authenticate with `gh auth token` (i.e. --github-token=$(gh auth token))
+  HELP
+  option :pull_request_id, required: true, desc: "Required. The ID of the pull request that you want to make the backport from. It should have the \"type: fix\" label."
+  option :exit_with_unstaged_changes, type: :boolean, default: true, desc: <<~HELP
+    Optional. Whether the script should exit with an error if there are unstaged changes in the current project.
+  HELP
+  default_task :backport
+
+  def backport
+    Decidim::MaintainersToolbox::ActionBackporter.new(
+      token: options[:github_token],
+      pull_request_id: options[:pull_request_id],
+      exit_with_unstaged_changes: options[:exit_with_unstaged_changes]
+    ).call
+  rescue Decidim::MaintainersToolbox::GithubManager::Querier::Base::InvalidMetadataError
+    puts "Metadata was not returned from the server. Please check that the provided pull request ID and GitHub token are correct."
+  end
+
+  def help
+    super("backport")
+  end
+
+  def self.exit_on_failure?
+    true
+  end
+end
+
+ActionBackporterCLI.start(ARGV)

data/exe/decidim-backporter

@@ -19,6 +19,9 @@ class BackporterCLI < Thor
   option :exit_with_unstaged_changes, type: :boolean, default: true, desc: <<~HELP
     Optional. Whether the script should exit with an error if there are unstaged changes in the current project.
   HELP
+  option :with_console, required: false, type: :boolean, default: true, desc: <<~HELP
+    Optional. Disables the shell dropout 
+  HELP
   default_task :backport
 
   def backport
@@ -26,7 +29,8 @@ class BackporterCLI < Thor
       token: options[:github_token],
       pull_request_id: options[:pull_request_id],
       version_number: options[:version_number],
-      exit_with_unstaged_changes: options[:exit_with_unstaged_changes]
+      exit_with_unstaged_changes: options[:exit_with_unstaged_changes],
+      with_console: options[:with_console]
     ).call
   rescue Decidim::MaintainersToolbox::GithubManager::Querier::Base::InvalidMetadataError
     puts "Metadata was not returned from the server. Please check that the provided pull request ID and GitHub token are correct."

data/lib/decidim/maintainers_toolbox/action_backporter.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative "github_manager/querier"
+require_relative "github_manager/poster"
+require_relative "git_backport_manager"
+
+module Decidim
+  module MaintainersToolbox
+    class ActionBackporter
+      class InvalidMetadataError < StandardError; end
+
+      DECIDIM_MAINTAINERS = ["alecslupu", "andreslucena"]
+
+      # @param token [String] token for GitHub authentication
+      # @param pull_request_id [String] the ID of the pull request that we want to backport
+      # @param exit_with_unstaged_changes [Boolean] wheter we should exit cowardly if there is any unstaged change
+      def initialize(token: , pull_request_id: ,exit_with_unstaged_changes: )
+        @token = token
+        @pull_request_id = pull_request_id
+        @exit_with_unstaged_changes = exit_with_unstaged_changes
+      end
+
+      def call
+        exit_with_errors("The requested PR #{pull_request_id} does not contain `type: fix`") unless pull_request_metadata[:labels].include?("type: fix")
+        exit_with_errors("The requested PR #{pull_request_id} is not merged") unless pull_request_metadata[:is_merged]
+        exit_with_errors("The requested PR #{pull_request_id} cannot be backported") if pull_request_metadata[:labels].include?("no-backport")
+
+        extract_versions.each do |version|
+          next if extract_backport_pull_request_for_version(related_issues, version)
+          system("decidim-backporter --github_token=#{token} --pull_request_id=#{pull_request_id} --version_number=#{version} --exit_with_unstaged_changes=#{exit_with_unstaged_changes} --with-console=false", exception: true)
+        rescue RuntimeError => e
+          puts e.message
+          create_backport_issue(version)
+        end
+      end
+
+      private
+
+      attr_reader :token, :pull_request_id, :exit_with_unstaged_changes
+
+      def create_backport_issue(version)
+        some_params = {
+          title: "Fail: automatic backport of \"#{pull_request_metadata[:title]}\"",
+          body: "Automatic backport of ##{pull_request_id} has failed for version #{version}. Please do this action manually.",
+          assignee: DECIDIM_MAINTAINERS,
+          labels: pull_request_metadata[:labels]
+        }
+
+        uri = "https://api.github.com/repos/decidim/decidim/issues"
+        Faraday.post(uri, some_params.to_json, { Authorization: "token #{token}" })
+      end
+
+      # same method exists in lib/decidim/maintainers_toolbox/backports_reporter/report.rb
+      def extract_backport_pull_request_for_version(related_issues, version)
+        related_issues = related_issues.select do |pull_request|
+          pull_request[:title].start_with?("Backport") && pull_request[:title].include?(version)
+        end
+        return if related_issues.empty?
+
+        related_issues.first
+      end
+
+      def extract_versions
+        return [] unless pull_request_metadata[:labels]
+
+        pull_request_metadata[:labels].map do |item|
+          item.match(/release: v(\d+\.\d+)/) { |m| m[1] }
+        end.compact
+      end
+
+      # Asks the metadata for a given issue or pull request on GitHub API
+      #
+      # @return [Faraday::Response] An instance that represents an HTTP response from making an HTTP request
+      # Same method exists in lib/decidim/maintainers_toolbox/backporter.rb
+      def pull_request_metadata
+        @pull_request_metadata ||= Decidim::MaintainersToolbox::GithubManager::Querier::ByIssueId.new(
+          token: token,
+          issue_id: pull_request_id
+        ).call
+      end
+
+      def related_issues
+        @related_issues ||= Decidim::MaintainersToolbox::GithubManager::Querier::RelatedIssues.new(
+          token: token,
+          issue_id: pull_request_id
+        ).call
+      end
+
+      # Exit the script execution with a message
+      #
+      # @return [void]
+      def exit_with_errors(message)
+        puts message
+        exit 1
+      end
+    end
+  end
+end

data/lib/decidim/maintainers_toolbox/backporter.rb

@@ -9,11 +9,12 @@ module Decidim
       # @param pull_request_id [String] the ID of the pull request that we want to backport
       # @param version_number [String] the version number of the release that we want to make the backport to
       # @param exit_with_unstaged_changes [Boolean] wheter we should exit cowardly if there is any unstaged change
-      def initialize(token:, pull_request_id:, version_number:, exit_with_unstaged_changes:)
+      def initialize(token:, pull_request_id:, version_number:, exit_with_unstaged_changes:, with_console:)
         @token = token
         @pull_request_id = pull_request_id
         @version_number = version_number
         @exit_with_unstaged_changes = exit_with_unstaged_changes
+        @with_console = with_console
       end
 
       # Handles the different tasks to create a backport:
@@ -32,7 +33,7 @@ module Decidim
 
       private
 
-      attr_reader :token, :pull_request_id, :version_number, :exit_with_unstaged_changes
+      attr_reader :token, :pull_request_id, :version_number, :exit_with_unstaged_changes, :with_console
 
       # Asks the metadata for a given issue or pull request on GitHub API
       #
@@ -52,7 +53,8 @@ module Decidim
           pull_request_id: pull_request_id,
           release_branch: release_branch,
           backport_branch: backport_branch(metadata[:title]),
-          exit_with_unstaged_changes: exit_with_unstaged_changes
+          exit_with_unstaged_changes: exit_with_unstaged_changes,
+          with_console: with_console
         ).call
       end
 

data/lib/decidim/maintainers_toolbox/git_backport_manager.rb

@@ -14,12 +14,13 @@ module Decidim
       # @param backport_branch [String] the name of the branch that we want to create
       # @param working_dir [String] current working directory. Useful for testing purposes
       # @param exit_with_unstaged_changes [Boolean] wheter we should exit cowardly if there is any unstaged change
-      def initialize(pull_request_id:, release_branch:, backport_branch:, working_dir: Dir.pwd, exit_with_unstaged_changes: false)
+      def initialize(pull_request_id:, release_branch:, backport_branch:, working_dir: Dir.pwd, exit_with_unstaged_changes: false, with_console: true)
         @pull_request_id = pull_request_id
         @release_branch = release_branch
         @backport_branch = sanitize_branch(backport_branch)
         @working_dir = working_dir
         @exit_with_unstaged_changes = exit_with_unstaged_changes
+        @with_console = with_console
       end
 
       # Handles all the different tasks involved on a backport with the git command line utility
@@ -64,7 +65,7 @@ module Decidim
 
       private
 
-      attr_reader :pull_request_id, :release_branch, :backport_branch, :working_dir
+      attr_reader :pull_request_id, :release_branch, :backport_branch, :working_dir, :with_console
 
       # Create the backport branch based on a release branch
       # Checks that this branch does not exist already, if it does then exits
@@ -96,8 +97,14 @@ module Decidim
         `git cherry-pick #{sha_commit}`
 
         unless $CHILD_STATUS.exitstatus.zero?
-          puts "Resolve the cherrypick conflict manually and exit your shell to keep with the process."
-          system ENV.fetch("SHELL")
+          error_message = "Resolve the cherrypick conflict manually and exit your shell to keep with the process."
+
+          if with_console
+            puts error_message
+            system ENV.fetch("SHELL")
+          else
+            exit_with_errors(error_message)
+          end
         end
       end
 

data/lib/decidim/maintainers_toolbox/github_manager/querier/by_issue_id.rb

@@ -35,6 +35,9 @@ module Decidim
 
             {
               id: metadata["number"],
+              state: metadata["state"],
+              is_pull_request: metadata["pull_request"].present?,
+              is_merged: (metadata["pull_request"]["merged_at"].present? rescue false),
               title: metadata["title"],
               labels: labels,
               type: labels.select { |l| l.match(/^type: /) || l == "target: developer-experience" },

data/lib/decidim/maintainers_toolbox/github_manager/querier/{by_title.rb → by_query.rb}

@@ -9,15 +9,13 @@ module Decidim
         # Makes a GET request for the list of Issues or Pull Requests in GitHub.
         #
         # @param token [String] token for GitHub authentication
-        # @param title [String] the title that we want to search by
-        # @param state [String] the state of the issue. By default is "open"
+        # @param query [Hash] the query to search
         #
         # @see https://docs.github.com/en/rest/issues/issues#list-repository-issues GitHub API documentation
-        class ByTitle < Decidim::MaintainersToolbox::GithubManager::Querier::Base
-          def initialize(title:, token:, state: "open")
-            @title = title
+        class ByQuery < Decidim::MaintainersToolbox::GithubManager::Querier::Base
+          def initialize(token:, query: {})
             @token = token
-            @state = state
+            @query = query
           end
 
           # Makes the GET request and parses the response of an Issue or Pull Request in GitHub
@@ -31,14 +29,12 @@ module Decidim
 
           private
 
-          attr_reader :title, :state
+          attr_reader :query
 
           def headers
             {
-              title: title,
-              state: state,
               per_page: 100
-            }
+            }.merge(query)
           end
 
           # Parses the response of an Issue or Pull Request in GitHub

data/lib/decidim/maintainers_toolbox/github_manager/querier.rb

@@ -15,7 +15,7 @@ module Decidim
       module Querier
         autoload :ByIssueId, "decidim/maintainers_toolbox/github_manager/querier/by_issue_id"
         autoload :ByLabel, "decidim/maintainers_toolbox/github_manager/querier/by_label"
-        autoload :ByTitle, "decidim/maintainers_toolbox/github_manager/querier/by_title"
+        autoload :ByQuery, "decidim/maintainers_toolbox/github_manager/querier/by_query"
         autoload :RelatedIssues, "decidim/maintainers_toolbox/github_manager/querier/related_issues"
       end
     end

data/lib/decidim/maintainers_toolbox/releaser.rb

@@ -2,7 +2,7 @@
 
 require "open3"
 require_relative "github_manager/poster"
-require_relative "github_manager/querier/by_title"
+require_relative "github_manager/querier/by_query"
 require_relative "changelog_generator"
 
 module Decidim
@@ -37,11 +37,15 @@ module Decidim
 
           run("git checkout #{release_branch}")
           run("git pull origin #{release_branch}")
+
           bump_decidim_version
           run("bin/rake update_versions")
+
           run("bin/rake patch_generators")
+
           run("bin/rake bundle")
           run("npm install")
+          run("bin/rake webpack") if Dir.exists?("decidim_app-design")
 
           check_tests
 
@@ -176,7 +180,7 @@ module Decidim
       # @return [void]
       def check_tests
         puts "Running specs"
-        output, status = capture("bin/rspec")
+        output, status = capture("bin/rspec", { "ENFORCED_LOCALES" => "en,ca,es", "SKIP_NORMALIZATION" => "true" })
 
         unless status.success?
           run("git restore .")
@@ -244,7 +248,7 @@ You will see errors such as `No matching version found for @decidim/browserslist
       #
       # @return [Boolean] - true if there is any open PR
       def pending_crowdin_pull_requests?
-        pull_requests = Decidim::MaintainersToolbox::GithubManager::Querier::ByTitle.new(token: @token, title: "New Crowdin updates").call
+        pull_requests = Decidim::MaintainersToolbox::GithubManager::Querier::ByQuery.new(token: @token, query: { title: "New Crowdin updates", creator: "decidim-bot" }).call
         pull_requests.any?
       end
 

data/lib/decidim/maintainers_toolbox/version.rb

@@ -2,6 +2,6 @@
 
 module Decidim
   module MaintainersToolbox
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: decidim-maintainers_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrés Pereira de Lucena
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 6.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 6.1.7
 - !ruby/object:Gem::Dependency
-  name: ruby-progressbar
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.7
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.7
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +99,7 @@ description: Tools for releasing, backporting, changelog generating, and working
 email:
 - andreslucena@gmail.com
 executables:
+- decidim-action-backporter
 - decidim-backporter
 - decidim-backports-checker
 - decidim-changelog-generator
@@ -108,11 +109,13 @@ extra_rdoc_files: []
 files:
 - README.md
 - decidim-maintainers_toolbox.gemspec
+- exe/decidim-action-backporter
 - exe/decidim-backporter
 - exe/decidim-backports-checker
 - exe/decidim-changelog-generator
 - exe/decidim-releaser
 - lib/decidim/maintainers_toolbox.rb
+- lib/decidim/maintainers_toolbox/action_backporter.rb
 - lib/decidim/maintainers_toolbox/backporter.rb
 - lib/decidim/maintainers_toolbox/backports_reporter/cli_report.rb
 - lib/decidim/maintainers_toolbox/backports_reporter/csv_report.rb
@@ -125,7 +128,7 @@ files:
 - lib/decidim/maintainers_toolbox/github_manager/querier/base.rb
 - lib/decidim/maintainers_toolbox/github_manager/querier/by_issue_id.rb
 - lib/decidim/maintainers_toolbox/github_manager/querier/by_label.rb
-- lib/decidim/maintainers_toolbox/github_manager/querier/by_title.rb
+- lib/decidim/maintainers_toolbox/github_manager/querier/by_query.rb
 - lib/decidim/maintainers_toolbox/github_manager/querier/related_issues.rb
 - lib/decidim/maintainers_toolbox/releaser.rb
 - lib/decidim/maintainers_toolbox/version.rb
@@ -138,7 +141,7 @@ metadata:
   funding_uri: https://opencollective.com/decidim
   homepage_uri: https://decidim.org
   source_code_uri: https://github.com/decidim/decidim
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Release related tools for the Decidim project
 test_files: []