decidim-maintainers_toolbox 0.1.0

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/time/zones"
+require_relative "base"
+
+module Decidim
+  module MaintainersToolbox
+    module GithubManager
+      module Querier
+        # Makes a GET request for the list of Issues or Pull Requests in GitHub.
+        # They must comply the following conditions:
+        # * To be merged in the period between the days to check from and today. (90 days by default)
+        # * To have the label that we are querying ("type: fix" by default)
+        # * To not have any of the excluded labels (["backport", "no-backport"] by default)
+        # * To have been merged
+        #
+        # @param token [String] token for GitHub authentication
+        # @param days_to_check_from [Integer] the number of days since the pull requests were merged from when we will start the check
+        # @param label [String] the label that we want to search by
+        # @param exclude_labels [Array] the labels that we want to exclude in the search
+        #
+        # @see https://docs.github.com/en/rest/issues/issues#list-repository-issues GitHub API documentation
+        class ByLabel < Decidim::MaintainersToolbox::GithubManager::Querier::Base
+          def initialize(token:, days_to_check_from: 90, label: "type: fix", exclude_labels: ["backport", "no-backport"])
+            @label = label
+            @exclude_labels = exclude_labels
+            @token = token
+            @days_to_check_from = days_to_check_from
+          end
+
+          # Makes the GET request and parses the response of an Issue or Pull Request in GitHub
+          #
+          # @return [Hash]
+          def call
+            parse json_response("https://api.github.com/repos/decidim/decidim/issues")
+          end
+
+          private
+
+          attr_reader :label, :exclude_labels, :days_to_check_from
+
+          def headers
+            Time.zone = "UTC"
+
+            {
+              labels: label,
+              state: "closed",
+              per_page: 100,
+              since: since.iso8601
+            }
+          end
+
+          def since
+            Time.zone.today - days_to_check_from
+          end
+
+          # Parses the response of an Issue or Pull Request in GitHub
+          #
+          # @return [Hash]
+          def parse(metadata)
+            metadata.map do |item|
+              next if has_any_of_excluded_labels?(item)
+              next unless merged?(item)
+              next unless merged_in_date_range?(item)
+
+              {
+                id: item["number"],
+                title: item["title"]
+              }
+            end.compact
+          end
+
+          def has_any_of_excluded_labels?(item)
+            item["labels"].map { |label| label.map { |_key, val| exclude_labels.include?(val) } }.flatten.any? true
+          end
+
+          def merged_at(item)
+            Date.parse(item["pull_request"]["merged_at"])
+          end
+
+          def merged?(item)
+            return false if item["pull_request"].nil?
+            return false if item["pull_request"]["merged_at"].nil?
+
+            merged_at(item).present?
+          rescue TypeError, Date::Error
+            false
+          end
+
+          def merged_in_date_range?(item)
+            merged_at(item) > since
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Decidim
+  module MaintainersToolbox
+    module GithubManager
+      module Querier
+        # 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"
+        #
+        # @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
+            @token = token
+            @state = state
+          end
+
+          # Makes the GET request and parses the response of an Issue or Pull Request in GitHub
+          #
+          # @return [Hash]
+          def call
+            data = json_response("https://api.github.com/repos/decidim/decidim/issues")
+
+            parse(data)
+          end
+
+          private
+
+          attr_reader :title, :state
+
+          def headers
+            {
+              title: title,
+              state: state,
+              per_page: 100
+            }
+          end
+
+          # Parses the response of an Issue or Pull Request in GitHub
+          #
+          # @return [Hash]
+          def parse(metadata)
+            metadata.map do |item|
+              {
+                id: item["number"],
+                title: item["title"]
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Decidim
+  module MaintainersToolbox
+    module GithubManager
+      module Querier
+        # Makes a GET request for the related issues of an Issue or Pull Request in GitHub
+        # Uses the Timeline events API endpoint
+        #
+        # @see https://docs.github.com/en/rest/issues/timeline?apiVersion=2022-11-28 GitHub API documentation
+        class RelatedIssues < Decidim::MaintainersToolbox::GithubManager::Querier::Base
+          def initialize(issue_id:, token:)
+            @issue_id = issue_id
+            @token = token
+          end
+
+          # Makes the GET request and parses the response of an Issue or Pull Request in GitHub
+          #
+          # @return [Hash]
+          def call
+            parse(json_response("https://api.github.com/repos/decidim/decidim/issues/#{@issue_id}/timeline"))
+          end
+
+          private
+
+          def headers
+            { per_page: 100 }
+          end
+
+          # Parses the response of an Issue or Pull Request in GitHub
+          #
+          # @return [Hash]
+          def parse(metadata)
+            references = metadata.select do |item|
+              item["event"] == "cross-referenced" && item["source"]["issue"]["repository"]["full_name"] == "decidim/decidim"
+            end
+            references.map do |item|
+              issue = item["source"]["issue"]
+
+              {
+                id: issue["number"],
+                title: issue["title"].strip,
+                state: issue.dig("pull_request", "merged_at").nil? ? issue["state"] : "merged"
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+require_relative "querier/by_issue_id"
+require_relative "querier/by_label"
+require_relative "querier/related_issues"
+
+module Decidim
+  module MaintainersToolbox
+    module GithubManager
+      # Allows to make GET requests to GitHub Rest API about Issues and Pull Requests
+      # @see https://docs.github.com/en/rest
+      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 :RelatedIssues, "decidim/maintainers_toolbox/github_manager/querier/related_issues"
+      end
+    end
+  end
+end

data/lib/decidim/maintainers_toolbox/releaser.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+
+require "open3"
+require_relative "github_manager/poster"
+require_relative "github_manager/querier/by_title"
+require_relative "changelog_generator"
+
+module Decidim
+  module MaintainersToolbox
+    class Releaser
+      class InvalidMetadataError < StandardError; end
+
+      class InvalidBranchError < StandardError; end
+
+      class InvalidVersionTypeError < StandardError; end
+
+      DECIDIM_VERSION_FILE = ".decidim-version"
+
+      # @param token [String] token for GitHub authentication
+      # @param version_type [String] The kind of release that you want to prepare. Supported values: rc, minor, patch
+      # @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(token:, version_type:, working_dir: Dir.pwd, exit_with_unstaged_changes: false)
+        @token = token
+        @version_type = version_type
+        @working_dir = working_dir
+        @exit_with_unstaged_changes = exit_with_unstaged_changes
+      end
+
+      def call
+        Dir.chdir(@working_dir) do
+          exit_if_unstaged_changes if @exit_with_unstaged_changes
+          exit_if_pending_crowdin_pull_request
+
+          puts "Starting the release process for #{version_number} in 10 seconds"
+          sleep 10
+
+          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")
+
+          check_tests
+
+          generate_changelog
+
+          run("git checkout -b chore/prepare/#{version_number}")
+          run("git commit -a -m 'Prepare #{version_number} release'")
+          run("git push origin chore/prepare/#{version_number}")
+
+          create_pull_request
+        end
+      end
+
+      private
+
+      # The git branch
+      #
+      # @return [String]
+      def branch
+        @branch ||= capture("git rev-parse --abbrev-ref HEAD")[0].strip
+      end
+
+      # Raise an error if the branch does not start with the preffix "release/"
+      # or returns the branch name
+      #
+      # @raise [InvalidBranchError]
+      #
+      # @return [String]
+      def release_branch
+        raise InvalidBranchError, "This is not a release branch, aborting" unless branch.start_with?("release/")
+
+        branch
+      end
+
+      # Changes the decidim version in the file
+      #
+      # @return [void]
+      def bump_decidim_version
+        File.write(DECIDIM_VERSION_FILE, version_number)
+      end
+
+      # The version number for the release that we are preparing
+      #
+      # @todo support the "minor" type version
+      #
+      # @return [String] the version number
+      def version_number
+        @version_number ||= case @version_type
+                            when "rc"
+                              next_version_number_for_release_candidate(old_version_number)
+                            when "patch"
+                              next_version_number_for_patch_release(old_version_number)
+                            else
+                              raise InvalidVersionTypeError, "This is not a supported version type"
+                            end
+      end
+
+      def parsed_version_number(version_number)
+        /(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)/ =~ version_number
+
+        [major.to_i, minor.to_i, patch.to_i]
+      end
+
+      # Given a version number, returns the next release candidate
+      #
+      # If the current version number is `dev`, then we return the `rc1` version
+      # If the current version number is `rc`, then we return the next `rc` version
+      # Else, it means is a `minor` or `patch` version. On those cases we raise an Exception, as releases candidates should
+      # be only done from a `dev` or a `rc` version.
+      #
+      # @raise [InvalidVersionTypeError]
+      #
+      # @param current_version_number [String] - The version number of the current version
+      #
+      # @return [String] - the new version number
+      def next_version_number_for_release_candidate(current_version_number)
+        if current_version_number.include? "dev"
+          major, minor, patch = parsed_version_number(current_version_number)
+          new_version_number = "#{major}.#{minor}.#{patch}.rc1"
+        elsif current_version_number.include? "rc"
+          new_rc_number = current_version_number.match(/rc(\d)/)[1].to_i + 1
+          new_version_number = current_version_number.gsub(/rc\d/, "rc#{new_rc_number}")
+        else
+          error_message = <<-EOMESSAGE
+          Trying to do a release candidate version from patch release. Bailing out.
+          You need to do a release candidate from a `dev` or from another `rc` version
+          EOMESSAGE
+          raise InvalidVersionTypeError, error_message
+        end
+
+        new_version_number
+      end
+
+      # Given a version number, returns the next patch release
+      #
+      # If the current version number is `dev`, then we raise an Exception, as you need to first do a release candidate.
+      # If the current version number is `rc`, then we return the `0` patch version
+      # Else, it means is a `patch` version, so we return the next patch version
+      #
+      # @raise [InvalidVersionTypeError]
+      #
+      # @param current_version_number [String] - The version number of the current version
+      #
+      # @return [String] - the new version number
+      def next_version_number_for_patch_release(current_version_number)
+        major, minor, patch = parsed_version_number(current_version_number)
+
+        if current_version_number.include? "dev"
+          error_message = <<-EOMESSAGE
+          Trying to do a patch version from dev release. Bailing out.
+          You need to do first a release candidate.
+          EOMESSAGE
+          raise InvalidVersionTypeError, error_message
+        elsif current_version_number.include? "rc"
+          new_version_number = "#{major}.#{minor}.0"
+        else
+          new_version_number = "#{major}.#{minor}.#{patch.to_i + 1}"
+        end
+
+        new_version_number
+      end
+
+      # The version number from the file
+      #
+      # @return [String] the version number
+      def old_version_number
+        File.read(DECIDIM_VERSION_FILE).strip
+      end
+
+      # Run the tests and if fails restore the changes using git and exit with an error
+      #
+      # @return [void]
+      def check_tests
+        puts "Running specs"
+        output, status = capture("bin/rspec")
+
+        unless status.success?
+          run("git restore .")
+          puts output
+          exit_with_errors("Tests execution failed. Fix the errors and run again.")
+        end
+      end
+
+      # Generates the changelog taking into account the last time the version changed
+      #
+      # @return [void]
+      def generate_changelog
+        sha_version = capture("git log -n 1 --pretty=format:%h -- .decidim-version")[0]
+        ChangeLogGenerator.new(token: @token, since_sha: sha_version).call
+        temporary_changelog = File.read("./temporary_changelog.md")
+        legacy_changelog = File.read("./CHANGELOG.md")
+        version_changelog = "## [#{version_number}](https://github.com/decidim/decidim/tree/#{version_number})\n\n#{temporary_changelog}\n"
+        changelog = legacy_changelog.gsub("# Changelog\n\n", "# Changelog\n\n#{version_changelog}")
+        File.write("./CHANGELOG.md", changelog)
+      end
+
+      # Creates the pull request for bumping the version
+      #
+      # @return [void]
+      def create_pull_request
+        base_branch = release_branch
+        head_branch = "chore/prepare/#{version_number}"
+
+        params = {
+          title: "Bump to v#{version_number} version",
+          body: "#### :tophat: What? Why?
+
+This PR changes the version of the #{release_branch} branch, so we can publish the release once this is approved and merged.
+
+#### Testing
+
+All the tests should pass, except for some generators tests, that will fail because the gems and NPM packages have not
+been actually published yet (as in sent to rubygems/npm).
+You will see errors such as `No matching version found for @decidim/browserslist-config@~0.xx.y` in the CI logs.
+
+:hearts: Thank you!
+        ",
+          labels: ["type: internal"],
+          head: head_branch,
+          base: base_branch
+        }
+        Decidim::MaintainersToolbox::GithubManager::Poster.new(token: @token, params: params).call
+      end
+
+      # Captures to output of a command
+      #
+      # @return [Array<String, Process::Status>] The stdout and stderr of the command and its status (aka error code)
+      def capture(cmd, env: {})
+        Open3.capture2e(env, cmd)
+      end
+
+      # Runs a command
+      #
+      # @return [void]
+      def run(cmd, out: $stdout)
+        system(cmd, out: out)
+      end
+
+      # Check if there is any open pull request from Crowdin in GitHub
+      #
+      # @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.any?
+      end
+
+      # Exit the script execution if there are any pull request from Crowdin open
+      #
+      # @return [void]
+      def exit_if_pending_crowdin_pull_request
+        return unless pending_crowdin_pull_requests?
+
+        error_message = <<-EOERROR
+  There are open pull requests from Crowdin in GitHub
+  Merge them and run again this script.
+        EOERROR
+        exit_with_errors(error_message)
+      end
+
+      # Exit the script execution with a message
+      # Exit the script execution if there are any unstaged changes
+      #
+      # @return [void]
+      def exit_if_unstaged_changes
+        return if `git diff`.empty?
+
+        error_message = <<-EOERROR
+  There are changes not staged in your project.
+  Please commit your changes or stash them.
+        EOERROR
+        exit_with_errors(error_message)
+      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/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Decidim
+  module MaintainersToolbox
+    VERSION = "0.1.0"
+  end
+end

data/lib/decidim/maintainers_toolbox.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "maintainers_toolbox/version"
+
+module Decidim
+  module MaintainersToolbox
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: decidim-maintainers_toolbox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrés Pereira de Lucena
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: Tools for releasing, backporting, changelog generating, and working with
+  GitHub
+email:
+- andreslucena@gmail.com
+executables:
+- decidim-backporter
+- decidim-backports-checker
+- decidim-changelog-generator
+- decidim-releaser
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- decidim-maintainers_toolbox.gemspec
+- exe/decidim-backporter
+- exe/decidim-backports-checker
+- exe/decidim-changelog-generator
+- exe/decidim-releaser
+- lib/decidim/maintainers_toolbox.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
+- lib/decidim/maintainers_toolbox/backports_reporter/report.rb
+- lib/decidim/maintainers_toolbox/changelog_generator.rb
+- lib/decidim/maintainers_toolbox/git_backport_checker.rb
+- lib/decidim/maintainers_toolbox/git_backport_manager.rb
+- lib/decidim/maintainers_toolbox/github_manager/poster.rb
+- lib/decidim/maintainers_toolbox/github_manager/querier.rb
+- 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/related_issues.rb
+- lib/decidim/maintainers_toolbox/releaser.rb
+- lib/decidim/maintainers_toolbox/version.rb
+homepage: https://decidim.org
+licenses:
+- AGPL-3.0
+metadata:
+  bug_tracker_uri: https://github.com/decidim/decidim/issues
+  documentation_uri: https://docs.decidim.org/
+  funding_uri: https://opencollective.com/decidim
+  homepage_uri: https://decidim.org
+  source_code_uri: https://github.com/decidim/decidim
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Release related tools for the Decidim project
+test_files: []