pr-merger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07bcad60e1e3ea9859a006c2d128d9d6064b1e28d203af88807dea4085e19d70
+  data.tar.gz: cf613b6b664e8000846cbd262237a926911360927aa3420c1809bb6ea5b0e360
+SHA512:
+  metadata.gz: 848dd327551abe6cd100640ef9b9844f7838e6c308b5a2a165e250e1564c33783e28edebdb8ec349b8cc7b9c3cb191ea665c67dc6a0216bf1026805ec4d1db0c
+  data.tar.gz: 3f15cdf97645f1d4ec9582154b660f3df64cf1412fb492b780dcd8c8cf491603aaa4c23255c943dc68c5f4523a22faacd46afe771b15cc00da4216f2c18eed64

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pr-merger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016+ Cloudaper
+
+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,67 @@
+# Pull Request Merger
+
+Merge open pull requests on GitHub all together to create a new branch with all changes.
+
+Read more about the workflow we use the PR Merger for at [@cloudaper](https://github.com/cloudaper) in our [Medium story](https://medium.com/cloudaper/devops-hack-make-all-the-work-in-progress-accessible-with-pull-request-merger-47b58dc51207).
+
+Any feedback or even a pull request welcomed!
+
+## Installation
+
+You need Ruby to use PR Merger.
+
+Run this command:
+
+```shell
+gem install pr-merger
+```
+
+or add
+
+```ruby
+gem 'pr-merger'
+```
+
+to your Gemfile.
+
+## Usage
+
+```shell
+$ pr-merger --help
+Usage: pr-merger --access-token TOKEN --base-repo REPO --base-branch BRANCH --merge-branch BRANCH [--fork-repo]
+```
+
+You have to provide several arguments to PR Merger:
+
+- **`--access-token`**  
+  This is GitHub personal access token to access the repository details and update [statuses](https://help.github.com/articles/about-status-checks). You can generate one in [user's settings](https://github.com/settings/tokens); select `repo` scope. Please read the [know issues](#known-issues) section below.  
+  E.g.: `472a3a8f5315a3435a295091a365d5f9fb736d84`.
+
+- **`--base-repo`**  
+  This is the name of the base repository.  
+  E.g.: `cloudaper/pr-merger`.
+
+- **`--base-branch`**  
+  This is the name of the base branch, where the pull requests are merged to – usually master.  
+  E.g.: `master`.
+
+- **`--merge-branch`**  
+  This is the name of newly created branch with merged pull requests.  
+  E.g.: `merged-prs`
+
+- **`--fork-repo`**  
+  Add this option if merging from forked repository: this means the base repository will be used instead of fork for base branch.
+
+The assembled command should look like this:
+
+```shell
+pr-merger --access-token 2a3a8f5315a3435a295091a365d5f9fb736d84 --base-repo "cloudaper/pr-merger" --base-branch master --merge-branch merged-prs
+```
+
+If there is any pull request you don't want to merge, just add `[skip merge]` after the pull request title.
+
+## Known issues
+
+Currently there are two possible security issues, which you should take into account before using PR Merger. First, PR Merger is using _Personal access token_, which basically equals to your GitHub password, it can therefore access all the repositories the user has access to. Second, if you want to merge PRs from forked repositories, the machine you're running PR Merger at has to have access to all those repositories – this means [SSH deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) cannot be used.
+
+Recommended way to solve both those issues is to create a separate [machine user](https://developer.github.com/v3/guides/managing-deploy-keys/#machine-users) with access only to the repositories in question. However, the token still enables a full control of those repositories.

data/Rakefile

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

data/bin/pr-merger

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.expand_path('lib')
+
+require 'optparse'
+require 'pr-merger'
+
+def show_version
+  puts "pr-merger v#{PrMerger::VERSION}"
+
+  exit 0
+end
+
+def show_help
+  puts <<~HELP
+    Usage: pr-merger --access-token TOKEN --base-repo REPO --base-branch BRANCH --merge-branch BRANCH [--fork-repo]
+  HELP
+
+  exit 0
+end
+
+options = {}
+
+parser = OptionParser.new do|opts|
+  opts.banner = "Usage: pr-merger [options]"
+
+  opts.on('--access-token TOKEN') do |option|
+    options[:access_token] = option
+  end
+
+  opts.on('--base-repo REPO') do |option|
+    options[:base_repo] = option
+  end
+
+  opts.on('--base-branch BRANCH') do |option|
+    options[:base_branch] = option
+  end
+
+  opts.on('--merge-branch BRANCH') do |option|
+    options[:merge_branch] = option
+  end
+
+  opts.on('--fork-repo') do
+    options[:fork_repo] = true
+  end
+
+  opts.on('-v', '--version') do
+    show_version
+  end
+
+  opts.on('--debug') do
+    options[:debug] = true
+  end
+
+  opts.on('-h', '--help') do
+    show_help
+  end
+end
+
+begin
+  parser.parse!
+
+  show_help if options.empty?
+
+  merger = PrMerger::Merger.new(access_token: options[:access_token])
+
+  exit merger.run(base_repo:    options[:base_repo],
+                  base_branch:  options[:base_branch],
+                  merge_branch: options[:merge_branch],
+                  fork_repo:    options[:fork_repo])
+
+rescue => e
+  STDERR.puts "ERROR: #{e.message}"
+
+  if options[:debug]
+    STDERR.puts
+    STDERR.puts e.backtrace
+  end
+
+  exit 1
+end

data/lib/pr-merger.rb

@@ -0,0 +1,122 @@
+require 'pr-merger/version'
+require 'tty-command'
+require 'octokit'
+
+Octokit.auto_paginate = true
+
+# Merges all opened GitHub PRs to a new branch
+module PrMerger
+  class Merger
+    APP_CONTEXT    = 'pr-merger'.freeze
+    SKIP_MERGE = '[skip merge]'.freeze
+
+    def initialize(access_token:)
+      @gh = Octokit::Client.new(access_token: access_token)
+    end
+
+    def run(base_repo:, base_branch:, merge_branch:, fork_repo:)
+      @base_repo   = base_repo
+      @base_branch = base_branch
+
+      pull_requests = @gh.pull_requests(@base_repo, state: 'open').reverse
+
+      cmd = TTY::Command.new
+      active_branch_result = cmd.run! 'git rev-parse --abbrev-ref HEAD'
+
+      if active_branch_result.success?
+        previous_branch = active_branch_result.out.strip
+      else
+        previous_branch = cmd.run('cat .git/HEAD').strip
+      end
+
+      cmd.run 'git checkout', @base_branch
+
+      if fork_repo
+        cmd.run! 'git remote add upstream', "git@github.com:#{@base_repo}.git"
+        cmd.run 'git fetch upstream', @base_branch
+        cmd.run 'git reset --hard', "upstream/#{@base_branch}"
+      else
+        cmd.run 'git reset --hard', "origin/#{@base_branch}"
+      end
+
+      cmd.run 'git checkout -b', merge_branch
+
+      merge_statuses = pull_requests.map do |pr|
+        process_pr(pr, cmd)
+      end
+
+      cmd.run 'git checkout', previous_branch
+
+      merge_statuses.all? { |status| status }
+    end
+
+    private
+
+    # Process a given pull request
+    def process_pr(pr, cmd)
+      head = pr[:head]
+      repo = head[:repo]
+
+      pending_status(pr, 'Merge in progress.')
+
+      return true if skip_pr?(pr)
+
+      begin
+        cmd.run 'git fetch', repo[:ssh_url], head[:ref] if repo
+
+        merge_status = cmd.run! 'git merge --no-ff --no-edit', head[:sha]
+
+        if merge_status.success?
+          success_status(pr, "Merge with '#{@base_branch}' was successful.")
+        else
+          cmd.run 'git merge --abort'
+
+          message = "Failed to merge '#{head[:ref]} with #{@base_branch}."
+          failure_status(pr, message)
+        end
+      rescue => e
+        failure_status(pr, "Merge encountered an error: #{e.message}.")
+
+        return false
+      end
+
+      true
+    end
+
+    # Skip a given pull request if it includes skip merge message
+    def skip_pr?(pr)
+      return false unless pr[:title].include?(SKIP_MERGE)
+
+      failure_status(pr, "Skipping #{pr[:head][:ref]}.")
+
+      true
+    end
+
+    def pending_status(pr, message)
+      send_status(pr, 'pending', message)
+    end
+
+    def error_status(pr, message)
+      send_status(pr, 'error', message)
+    end
+
+    def failure_status(pr, message)
+      send_status(pr, 'failure', message)
+    end
+
+    def success_status(pr, message)
+      send_status(pr, 'success', message)
+    end
+
+    # Send Octokit status
+    def send_status(pr, status, message)
+      @gh.create_status(
+        @base_repo,
+        pr[:head][:sha],
+        status,
+        context: APP_CONTEXT,
+        description: message[0..140]
+      )
+    end
+  end
+end

data/lib/pr-merger/version.rb

@@ -0,0 +1,3 @@
+module PrMerger
+  VERSION = '1.0.0'.freeze
+end

data/pr-merger.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pr-merger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pr-merger'
+  spec.version       = PrMerger::VERSION
+  spec.authors       = ['Tibor Szolár', 'Josef Strzibny']
+  spec.email         = ['tibor.szolar@seznam.cz', 'strzibny@strzibny.name']
+
+  spec.summary       = %q{Merges all opened GitHub PRs to a new branch.}
+  spec.description   = %q{}
+  spec.homepage      = 'https://github.com/cloudaper/pr-merger'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_runtime_dependency 'octokit', '~> 4.0'
+  spec.add_runtime_dependency 'tty-command', '~> 0.2'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: pr-merger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tibor Szolár
+- Josef Strzibny
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: tty-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: ''
+email:
+- tibor.szolar@seznam.cz
+- strzibny@strzibny.name
+executables:
+- pr-merger
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/pr-merger
+- lib/pr-merger.rb
+- lib/pr-merger/version.rb
+- pr-merger.gemspec
+homepage: https://github.com/cloudaper/pr-merger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Merges all opened GitHub PRs to a new branch.
+test_files: []