git-pr-release-roadrunner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a689cf932f38077f8f0d23da3949b9c98261644f20ed22870e2d0ae4fb0b147
+  data.tar.gz: 9ba85b17b301d6aec00a0fa0bb7acac42a084dd554a4573c2c6bd44facdb7a04
+SHA512:
+  metadata.gz: ce83873a6c66bce05955b09ef4d9c7bc0e200fd87a885381c87c15fbcad24915cf89aec3c89d854f5d7764cf43492bba0a1b751c48cb22a4412fb3733c5e504c
+  data.tar.gz: a180b841f26f58261e6d6cb2cbb259d7e3b986fc7920e5155a0ca7084f44b38737fa03fe30efc4b9459d5e762a7a542d7ed920aa3b50d89fb6e61b6219055eb6

data/.circleci/config.yml

@@ -0,0 +1,13 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: ruby:2.5.7
+    steps:
+      - checkout
+      - run:
+          name: Run the default task
+          command: |
+            gem install bundler -v 2.3.19
+            bundle install
+            bundle exec rake

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+*.gem
+Gemfile.lock
+/.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at pcorrea@roadrunnerwm.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# gem "rails"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Peter Correa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Git::Pr::Release::Roadrunner
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/git/pr/release/roadrunner`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add git-pr-release-roadrunner
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install git-pr-release-roadrunner
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/git-pr-release-roadrunner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/git-pr-release-roadrunner/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Git::Pr::Release::Roadrunner project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/git-pr-release-roadrunner/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "git/pr/release/roadrunner"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/git-pr-release-roadrunner

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "git/pr/release"
+
+Git::Pr::Release::CLI.start

data/git-pr-release-roadrunner.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "git-pr-release-roadrunner"
+  spec.version       = '0.0.1'
+  spec.authors       = ["trashypete"]
+  spec.email         = ["n/a"]
+  spec.summary       = 'Creates a release pull request'
+  spec.description   = 'git-pr-release creates a pull request which summarizes feature branches that are to be released into production'
+  spec.homepage      = ''
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'octokit', '>= 4.23.0'
+  spec.add_dependency 'highline'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'diff-lcs'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'webmock'
+
+  spec.license = 'MIT'
+end

data/lib/git/pr/release/cli.rb

@@ -0,0 +1,271 @@
+require 'octokit'
+require 'optparse'
+
+module Git
+  module Pr
+    module Release
+      class CLI
+        include Git::Pr::Release::Util
+        attr_reader :repository, :production_branch, :staging_branch, :template_path, :labels
+
+        def self.start
+          result = self.new.start
+          exit result
+        end
+
+        def initialize
+          @dry_run  = false
+          @json     = false
+          @no_fetch = false
+          @squashed = false
+        end
+
+        puts "---Generating RoadRunner Release PR----"
+
+        def start
+          OptionParser.new do |opts|
+            opts.on('-n', '--dry-run', 'Do not create/update a PR. Just prints out') do |v|
+              @dry_run = v
+            end
+            opts.on('--json', 'Show data of target PRs in JSON format') do |v|
+              @json = v
+            end
+            opts.on('--no-fetch', 'Do not fetch from remote repo before determining target PRs (CI friendly)') do |v|
+              @no_fetch = v
+            end
+            opts.on('--squashed', 'Handle squash merged PRs') do |v|
+              @squashed = v
+            end
+            opts.on('--overwrite-description', 'Force overwrite PR description') do |v|
+              @overwrite_description = v
+            end
+          end.parse!
+
+          ### Set up configuration
+          configure
+
+          ### Fetch merged PRs
+          merged_prs = fetch_merged_prs
+          if merged_prs.empty?
+            say 'No pull requests to be released', :error
+            return 1
+          end
+
+          ### Create a release PR
+          create_release_pr(merged_prs)
+          return 0
+        end
+
+        def client
+          @client ||= Octokit::Client.new :access_token => obtain_token!
+        end
+
+        def configure
+          host, @repository, scheme = host_and_repository_and_scheme
+
+          if host
+            if scheme == 'https' # GitHub Enterprise
+              ssl_no_verify = %w[true 1].include? ENV.fetch('GIT_PR_RELEASE_SSL_NO_VERIFY') { git_config('ssl-no-verify') }
+              if ssl_no_verify
+                OpenSSL::SSL.const_set :VERIFY_PEER, OpenSSL::SSL::VERIFY_NONE
+              end
+            end
+
+            Octokit.configure do |c|
+              c.api_endpoint = "#{scheme}://#{host}/api/v3"
+              c.web_endpoint = "#{scheme}://#{host}/"
+            end
+          end
+
+          @production_branch = ENV.fetch('GIT_PR_RELEASE_BRANCH_PRODUCTION') { git_config('branch.production') } || 'master'
+          @staging_branch    = ENV.fetch('GIT_PR_RELEASE_BRANCH_STAGING') { git_config('branch.staging') }       || 'staging'
+          @template_path     = ENV.fetch('GIT_PR_RELEASE_TEMPLATE') { git_config('template') }
+
+          _labels = ENV.fetch('GIT_PR_RELEASE_LABELS') { git_config('labels') }
+          @labels = _labels && _labels.split(/\s*,\s*/) || []
+
+          say "Repository:        #{repository}", :debug
+          say "Production branch: #{production_branch}", :debug
+          say "Staging branch:    #{staging_branch}", :debug
+          say "Template path:     #{template_path}", :debug
+          say "Labels             #{labels}", :debug
+        end
+
+        def fetch_merged_prs
+          bool = git(:'rev-parse', '--is-shallow-repository').first.chomp
+          if bool == 'true'
+            git(:fetch, '--unshallow')
+          end
+          git :remote, 'update', 'origin' unless @no_fetch
+
+          merged_pull_request_numbers = fetch_merged_pr_numbers_from_git_remote
+          if @squashed
+            merged_pull_request_numbers.concat(fetch_squash_merged_pr_numbers_from_github)
+          end
+
+          merged_prs = merged_pull_request_numbers.uniq.sort.map do |nr|
+            pr = client.pull_request repository, nr
+            say "To be released: ##{pr.number} #{pr.title}", :notice
+            pr
+          end
+
+          merged_prs
+        end
+
+        def fetch_merged_pr_numbers_from_git_remote
+          merged_feature_head_sha1s = git(:log, '--merges', '--pretty=format:%P', "origin/#{production_branch}..origin/#{staging_branch}").map do |line|
+            main_sha1, feature_sha1 = line.chomp.split /\s+/
+            feature_sha1
+          end
+
+          git('ls-remote', 'origin', 'refs/pull/*/head').map do |line|
+            sha1, ref = line.chomp.split /\s+/
+
+            if merged_feature_head_sha1s.include? sha1
+              if %r<^refs/pull/(\d+)/head$>.match ref
+                pr_number = $1.to_i
+
+                if git('merge-base', sha1, "origin/#{production_branch}").first.chomp == sha1
+                  say "##{pr_number} (#{sha1}) is already merged into #{production_branch}", :debug
+                else
+                  pr_number
+                end
+              else
+                say "Bad pull request head ref format: #{ref}", :warn
+                nil
+              end
+            end
+          end.compact
+        end
+
+        def search_issue_numbers(query)
+          sleep 1
+          say "search issues with query:#{query}", :debug
+          # Fortunately, we don't need to take care of the page count in response, because
+          # the default value of per_page is 30 and we can't specify more than 30 commits due to
+          # the length limit specification of the query string.
+          client.search_issues("#{query}")[:items].map(&:number)
+        end
+
+        def fetch_squash_merged_pr_numbers_from_github
+          # When "--abbrev" is specified, the length of the each line of the stdout isn't fixed.
+          # It is just a minimum length, and if the commit cannot be uniquely identified with
+          # that length, a longer commit hash will be displayed.
+          # We specify this option to minimize the length of the query string, but we use
+          # "--abbrev=7" because the SHA syntax of the search API requires a string of at
+          # least 7 characters.
+          # ref. https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests#search-by-commit-sha
+          # This is done because there is a length limit on the API query string, and we want
+          # to create a string with the minimum possible length.
+          shas = git(:log, '--pretty=format:%h', "--abbrev=7", "--no-merges", "--first-parent",
+            "origin/#{production_branch}..origin/#{staging_branch}").map(&:chomp)
+
+          pr_nums = []
+          query_base = "repo:#{repository} is:pr is:closed"
+          query = query_base
+          # Make bulk requests with multiple SHAs of the maximum possible length.
+          # If multiple SHAs are specified, the issue search API will treat it like an OR search,
+          # and all the pull requests will be searched.
+          # This is difficult to read from the current documentation, but that is the current
+          # behavior and GitHub support has responded that this is the spec.
+          shas.each do |sha|
+            # Longer than 256 characters are not supported in the query.
+            # ref. https://docs.github.com/en/rest/reference/search#limitations-on-query-length
+            if query.length + 1 + sha.length >= 256
+              pr_nums.concat(search_issue_numbers(query))
+              query = query_base
+            end
+            query += " " + sha
+          end
+          if query != query_base
+              pr_nums.concat(search_issue_numbers(query))
+          end
+          pr_nums
+        end
+
+        def create_release_pr(merged_prs)
+          found_release_pr = detect_existing_release_pr
+          create_mode = found_release_pr.nil?
+
+          if create_mode
+            if @dry_run
+              release_pr = nil
+              changed_files = []
+            else
+              release_pr = prepare_release_pr
+              changed_files = pull_request_files(release_pr)
+            end
+          else
+            release_pr = found_release_pr
+            changed_files = pull_request_files(release_pr)
+          end
+
+          pr_title, pr_body = if @overwrite_description
+                                build_pr_title_and_body(release_pr, merged_prs, changed_files, template_path)
+                              else
+                                build_and_merge_pr_title_and_body(release_pr, merged_prs, changed_files)
+                              end
+
+          if @dry_run
+            say 'Dry-run. Not updating PR', :info
+            say pr_title, :notice
+            say pr_body, :notice
+            dump_result_as_json( release_pr, merged_prs, changed_files ) if @json
+            return
+          end
+
+          update_release_pr(release_pr, pr_title, pr_body)
+
+          say "#{create_mode ? 'Created' : 'Updated'} pull request: #{release_pr.rels[:html].href}", :notice
+          dump_result_as_json( release_pr, merged_prs, changed_files ) if @json
+        end
+
+        def detect_existing_release_pr
+          say 'Searching for existing release pull requests...', :info
+          user=repository.split("/")[0]
+          client.pull_requests(repository, head: "#{user}:#{staging_branch}", base: production_branch).first
+        end
+
+        def prepare_release_pr
+          client.create_pull_request(
+            repository, production_branch, staging_branch, 'Preparing release pull request...', ''
+          )
+        end
+
+        def build_and_merge_pr_title_and_body(release_pr, merged_prs, changed_files)
+          # release_pr is nil when dry_run && create_mode
+          old_body = (release_pr && release_pr.body != nil) ? release_pr.body : ""
+          pr_title, new_body = build_pr_title_and_body(release_pr, merged_prs, changed_files, template_path)
+
+          [pr_title, merge_pr_body(old_body, new_body)]
+        end
+
+        def update_release_pr(release_pr, pr_title, pr_body)
+          say 'Pull request body:', :debug
+          say pr_body, :debug
+
+          client.update_pull_request(
+            repository, release_pr.number, :title => pr_title, :body => pr_body
+          )
+
+          unless labels.empty?
+            client.add_labels_to_an_issue(
+              repository, release_pr.number, labels
+            )
+          end
+        end
+
+        # Fetch PR files of specified pull_request
+        def pull_request_files(pull_request)
+          return [] if pull_request.nil?
+
+          # Fetch files as many as possible
+          client.auto_paginate = true
+          files = client.pull_request_files repository, pull_request.number
+          client.auto_paginate = false
+          return files
+        end
+      end
+    end
+  end
+end

data/lib/git/pr/release/dummy_pull_request.rb

@@ -0,0 +1,23 @@
+module Git
+  module Pr
+    module Release
+      class DummyPullRequest
+        def initialize
+          # nop
+        end
+
+        def to_checklist_item
+          "- [ ] #??? THIS IS DUMMY PULL REQUEST"
+        end
+
+        def html_link
+          'http://github.com/DUMMY/DUMMY/issues/?'
+        end
+
+        def to_hash
+          { :data => {} }
+        end
+      end
+    end
+  end
+end

data/lib/git/pr/release/pull_request.rb

@@ -0,0 +1,54 @@
+module Git
+  module Pr
+    module Release
+      class PullRequest
+        include Git::Pr::Release::Util
+        extend Git::Pr::Release::Util
+        attr_reader :pr
+
+        def initialize(pr)
+          @pr = pr
+        end
+
+        def to_checklist_item(print_title = false)
+          if print_title
+            "- [ ] ##{pr.number} #{pr.title}" + mention
+          else
+            "- [ ] ##{pr.number}" + mention
+          end
+        end
+
+        def html_link
+          pr.rels[:html].href
+        end
+
+        def to_hash
+          { :data => @pr.to_hash }
+        end
+
+        def mention
+          mention = case PullRequest.mention_type
+                    when 'author'
+                      pr.user ? "@#{pr.user.login}" : nil
+                    else
+                      pr.assignee ? "@#{pr.assignee.login}" : pr.user ? "@#{pr.user.login}" : nil
+                    end
+
+          mention ? " #{mention}" : ""
+        end
+
+        def self.mention_type
+          @mention_type ||= (ENV.fetch('GIT_PR_RELEASE_MENTION') { git_config('mention') } || 'default')
+        end
+
+        def method_missing(name, *args, &block)
+          @pr.public_send name, *args, &block
+        end
+
+        def respond_to_missing?(name, include_private = false)
+          @pr.respond_to?(name, include_private)
+        end
+      end
+    end
+  end
+end