pr_releasenotes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 950d6b6e778e173335598ed4574806b6bbd3db28575eccf5a3c40d33fac844c7
+  data.tar.gz: 9cd54bffe0f6d5ea60c3058f7e3cba1e7b09f29fe14da8f532398f24937f5ce0
+SHA512:
+  metadata.gz: fb18ff14b3a0a87bbe379d4a8c4b5abedd6ece5d660d147af49b8caddbd3ee18c81a6d0dad566111a71a5939086ae313bdd215da48c13cb3ceff19799bc076a4
+  data.tar.gz: 2f12d003a12abdb59025ea5d1e200b16625548d85c141d5ba18f7d804df47e7a2c96316e63e7e2b9c028550949d8dc883532e5ac7ce498b36dfe2763040757c0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem
+.rakeTasks

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.0
+- 2.1
+- 2.2
+- 2.3
+script:
+  - rake clean
+  - rake build

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# For additional security under Bundler 1.x versions
+# https://bundler.io/guides/git.html#security
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}.git" }
+
+# Specify your gem's dependencies in pr_releasenotes.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 Bazaarvoice, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/OWNERS

@@ -0,0 +1,2 @@
+# Owning team.
+bulk-team@bazaarvoice.com

data/README.md

@@ -0,0 +1,93 @@
+# pr_releasenotes
+
+## Overview
+
+Create release notes for your github repo using the descriptions of pull requests  in each release. Simply invoking:
+
+    $ pr_releasenotes -r <user/repo> -t <token> -s <latest_tagged_release>
+
+will generate release notes from your latest release tag to the tip of the master branch.
+
+## Why this tool vs others
+
+There are quite a few online tools for generating release notes based on github history, but all the ones I've found rely on commit messages. This makes them inflexible, since it would require rewriting commit history in order to make any changes to the generated notes.
+
+This tool uses the pull request descriptions, so the release notes for any version can be updated at any time by simply updating the corresponding pull request's description and rerunning this tool.
+
+Secondly, this tool provides the additional option to post the release notes back to the github releases page.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pr_releasenotes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pr_releasenotes
+
+## Usage
+
+The minimum configuration necessary to run the tool is the repo, github token and a start release tag:
+
+    $ pr_releasenotes --repo <user/repo> --token <token> --start <latest_tagged_release>
+
+Additional options can be specified either by passing a yaml configuration to the included executable:
+
+    $ pr_releasenotes --config <config.yaml> --token <token> --start <start_version> --end <end_version> --branch <non-default branch>
+
+or by invoking the gem directly from ruby code:
+
+```ruby
+require 'pr_releasenotes'
+
+include PrReleasenotes
+
+PrReleasenotes.configure do |config|
+  config.repo('user/repo')
+  config.token('github_token')
+  config.parse_args(ARGV)
+end
+
+ReleaseNotes.new.run
+```
+
+Get a brief usage summary by running
+
+    $ pr_releasenotes --help
+
+
+See the [examples folder](examples) for some sample yaml configuration files.
+
+### Github token permissions
+
+This tool does require a github token since it accesses the github api. However any token created should have only as many, or rather as few, permissions as needed.
+
+A suitable token can be generated using the Github [Personal Access Tokens](https://github.com/settings/tokens) page. Depending on the use, the following permissions are required on the token:
+
+* Print out the release notes for a public repo on stdout:
+  * no permissions selected, i.e. public access
+* Update releases on github for a public repo:
+  * public_repo scope, i.e. write access to the user's public repos.
+* Print release notes or update releases on private repos:
+  * repo scope, i.e. read/write access to all private repos.
+
+**Add permissions with caution, and only if necessary!**
+
+Unfortunately, github currently does not provide separate write access for releases from write access for code, so these permissions are required for the corresponding use. Although this gem was written to make the minimal necessary use of the token, both the public_repo and repo scope tokens are nearly as powerful as your password, and should be well protected.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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/bazaarvoice/pr_releasenotes.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pr_releasenotes"
+
+# 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/examples/custom_config.yaml

@@ -0,0 +1,23 @@
+#
+# Sample configuration containing custom release notes, categorization and jira support. Assumes
+# a PR template that looks like custom_template.md
+#
+
+# Name of your repo in user/repo format
+repo:
+
+# Release notes parsing options. Note that comments will always get stripped
+
+# Assumes a separate Release Notes section in the PR description
+relnotes_regex: /.*### Release Notes(.*)/m
+relnotes_group: 1 # group to capture from the regex
+
+# Enable categorization
+categorize: true
+
+# Update to your own jira server
+jira_baseurl: 'https://issues.apache.org/jira/browse/'
+
+# Enable pagination
+auto_paginate: true
+

data/examples/custom_template.md

@@ -0,0 +1,15 @@
+<!--
+Custom template that can be used with custom_config.yaml. Save this file under .github/PULL_REQUEST_TEMPLATE.md to ensure all pull requests follow this template.
+ -->
+
+### Description
+<!-- Internal changes section. If this PR has only external facing changes, remove this section, including heading. -->
+
+### Release Notes
+<!-- External facing changes section. If this PR has only internal changes, remove this entire Release Notes section, including heading. Otherwise, remove any categories below that are not relevant to these changes. Be sure to maintain the 3# headings above and bullet format below, so that the release notes can get parsed/rolled up properly later. The leading numerical comments on the category names allow sorting the categories, so do not strip them off.-->
+* <!--01-->Manual Deploy Steps
+  * <!-- Add note here to provide more detail about the steps needed prior to or during deployment of a version containing this PR's changes. -->
+* <!--02-->Category A
+  * <!-- Add note here to provide more detail, or remove the sub-bullets so that only the PR title is included in the release notes under this category. -->
+* <!--03-->Category B
+* <!--04-->Category C

data/examples/default_config.yaml

@@ -0,0 +1,71 @@
+#
+# Sample configuration containing default configuration values
+#
+
+# Name of your repo in user/repo format. Defaults to nil and must be overridden in the yaml or on the cmd line.
+# repo: 
+
+# Release notes will be pulled from PRs merged to this branch. Defaults to master.
+# branch: master
+
+# Version range from which release notes should be gathered
+
+# Extract pull requests starting from this version. Defaults to nil for latest published release. Override if
+# there are no published releases yet.
+# Note: Although this parameter is listed here for completeness, this will likely be specified on the cmd line
+# since its value will vary with each release.
+# start_version:
+
+# Defaults to nil for latest commit. nil will also skip the creation of a github release
+# end_version:
+
+# If all your tags have a common prefix, add that here, and use just the varying suffix as the 
+# start/end version arguments. Defaults to blank.
+# tag_prefix: 
+
+# Short sha uniqueness threshold. Shas shorter than this may collide with other commits. When searching for
+# PRs related to a set of commits, shorter shas means more of them can be added into each query, allowing for
+# fewer calls to github search.
+# min_sha_size: 7
+
+# Whether to include even PRs not matching the relnotes_regex
+# include_all_prs: true
+
+# Finish by posting release notes to github
+# github_release: false
+
+
+# Release notes parsing options. Note that comments will always get stripped
+
+# By default, the entire PR description will be used.
+# relnotes_regex: '/.*/m'
+
+# group to capture from the above regex
+# relnotes_group: 0
+
+
+# Set categorization options
+
+# Set to true to enable categorization
+# categorize: false
+
+# Prefix to use to detect categories in the PR description
+# category_prefix: '^\* '
+
+# PRs without categories will get included into this default category
+# category_default: '<!--99-->Other'
+
+# Add a prefix to the release notes items
+# relnotes_hdr_prefix: '### '
+
+
+# Optional jira url to auto link all strings matching a jira ticket pattern
+# Default to nil to skip auto link
+# jira_baseurl:
+
+
+# !!!CAUTION!!! this will auto paginate github api calls, and potentially overrun your rate limits! Do not try 
+# to get release notes for all history for your project. Limit to no more than 2-3 pages worth of commits per
+# the UI.
+# auto_paginate: false
+

data/exe/pr_releasenotes

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'pr_releasenotes'
+
+include PrReleasenotes
+
+PrReleasenotes.configure do |config|
+  config.parse_args(ARGV)
+end
+
+ReleaseNotes.new.run

data/lib/pr_releasenotes/configuration.rb

@@ -0,0 +1,144 @@
+module PrReleasenotes
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configuration
+    self.config ||= Configuration.new
+  end
+
+  def self.configure
+    configuration
+    yield(config)
+  end
+
+  class Configuration
+
+    require 'optparse'
+    require 'yaml'
+    require 'logger'
+    require 'to_regexp'
+    require "pr_releasenotes/version"
+
+    attr_accessor :repo, :token, :tag_prefix, :min_sha_size, :start_version, :end_version,
+                  :branch, :include_all_prs, :github_release, :relnotes_group,
+                  :categorize, :category_prefix, :category_default, :relnotes_hdr_prefix,
+                  :jira_baseurl, :auto_paginate, :log
+
+    attr_reader :relnotes_regex
+
+
+    def initialize
+      @log = Logger.new(STDOUT)
+      @log.level = Logger::INFO
+
+      # Name of your repo in user/repo format
+      @repo = nil
+      # If all your tags have a common prefix, add that here, and use just the varying suffix as the argument
+      @tag_prefix = ''
+      # Short sha uniqueness threshold. Shas shorter than this may collide with other commits
+      @min_sha_size = 7
+      # Version range from which release notes should be gathered
+      @start_version = nil  # nil for latest released version
+      @end_version = nil    # nil for latest commit. nil will skip the creation of a github release
+      # Release notes will be pulled from PRs merged to this branch
+      @branch = 'master'
+      # Whether to include even PRs without explicit release notes
+      @include_all_prs = true
+      # Finish by posting release notes to github
+      @github_release = false
+
+      # Release notes parsing options. Note that comments will always get stripped
+      # Use .* with group 0 to use the entire PR description as the notes
+      @relnotes_regex = /.*/m
+      @relnotes_group = 0 # group to capture from the regex
+
+      # Set categorization options
+      @categorize = false # false to disable categorization
+      @category_prefix = '^\* '
+      # PRs without categories will get included into this default category
+      @category_default = '<!--99-->Other'
+      # Add a prefix to the release notes items
+      @relnotes_hdr_prefix = '### '
+
+      # Optional jira url to auto link all strings matching a jira ticket pattern
+      # Set to nil to skip auto link
+      @jira_baseurl = nil
+
+      # !!!CAUTION!!! this will auto paginate, and potentially overrun your rate limits! Do not try to get
+      # release notes for all history for your project. Limit to no more than 2-3 pages worth of commits per
+      # the UI.
+      @auto_paginate = false
+    end
+
+    def dump
+      instance_variables.map do |var|
+        "#{var}: #{instance_variable_get(var)}"
+      end
+    end
+
+    def relnotes_regex= (regex_str)
+      @relnotes_regex = regex_str.to_regexp
+    end
+
+    def parse_args (args)
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: pr_releasenotes [options]"
+
+        opts.separator ''
+        opts.on('-c', '--config <config.yaml>', 'Yaml configuration') do |config|
+          YAML.load_file(config).each do |k, v|
+            begin
+              # Try calling public setter for this option
+              public_send("#{k}=",  v)
+            rescue NoMethodError => e
+              raise "#{e.message} caused by (#{config}) Invalid key '#{k}'"
+            end
+          end
+        end
+
+        opts.separator ''
+        opts.on('-r', '--repo   <user/repo>', 'Repo to scan for pull requests') do |repo|
+          @repo = repo
+        end
+        opts.on('-t', '--token  <token>', 'Github token with repo scope') do |token|
+          @token = token
+        end
+
+        opts.separator ''
+        opts.on('-s', '--start  <version>', 'Get release notes from this version tag. (Default: latest release)') do |version|
+          @start_version = version
+        end
+        opts.on('-e', '--end    <version>', 'Get release notes till this version tag. (Default: latest commit, skips creating github release)') do |version|
+          @end_version = version
+        end
+        opts.on('-b', '--branch <branchname>', 'Use pull requests to this branch. (Default: master)') do |branch|
+          @branch = branch
+        end
+
+        opts.separator ''
+        opts.on('-p', '--post-to-github', 'Create/update release on github') do
+          @github_release = true
+        end
+
+        opts.separator ''
+        opts.on('-d', '--debug', 'Enable debug logging') do
+          @log.level = Logger::DEBUG
+          @log.debug 'Debug mode enabled'
+        end
+        opts.on_tail('-h', '--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+        opts.on_tail('-v', '--version', 'Show version') do
+          puts ::VERSION
+          exit
+        end
+      end
+
+      opt_parser.parse!(args)
+    end
+
+  end
+end

data/lib/pr_releasenotes/version.rb

@@ -0,0 +1,3 @@
+module PrReleasenotes
+  VERSION = "0.0.1"
+end

data/lib/pr_releasenotes.rb

@@ -0,0 +1,220 @@
+require "pr_releasenotes/configuration"
+
+# Generate release notes from github pull requests, and optionally
+# post to github releases
+module PrReleasenotes
+
+  class ReleaseNotes
+
+    require 'octokit'
+
+    attr_reader :config, :git_client, :log
+
+    def initialize
+
+      @config = PrReleasenotes.configuration
+      @log = config.log
+
+      raise "No repo defined! Run with -h for usage." if config.repo.nil?
+      raise "Missing github token! Run with -h for usage." if config.token.nil?
+
+      Octokit.auto_paginate = config.auto_paginate
+      @git_client ||= Octokit::Client.new(:access_token => config.token)
+      log.info 'Created github client.'
+
+    end
+
+    def run
+      # Infer start version if necessary
+      set_start_version
+      log.info "Retrieving release notes between #{config.start_version} and #{config.end_version.nil? ? 'now' : config.end_version} on branch #{config.branch}"
+      # Get commits between versions
+      commits_for_versions = get_commits_for_versions
+      # Get merged PRs for those commits
+      prs = get_prs_for_commits(commits_for_versions)
+      # Get release notes from those PRs
+      notes_by_pr = get_releasenotes_for_prs(prs)
+      # Convert to a single string
+      notes_str = get_notes_str(notes_by_pr)
+      log.info "Release Notes:\n\n#{notes_str}"
+      # Optionally post to github as a new or updated release
+      post_to_github(notes_str) if config.github_release
+    end
+
+    def set_start_version
+      if config.start_version.nil?
+        # If start version isn't set, try to infer from the latest github release
+        begin
+          releases = git_client.releases(config.repo)
+                         .sort_by { |release| release[:created_at]}.reverse # order by create date, newest first
+          release = releases.find { |release|
+            unless release[:draft]
+              # is a pre-release or published release, so check if this release is an ancestor of the current branch
+              # "diverged" indicates it was on a different branch & "ahead" indicates it's after the
+              # specified end_version, so neither can be used as a start_version
+              # "behind" indicates it's an ancestor and can be used as a start_version,
+              git_client.compare(config.repo, config.branch, release[:tag_name])[:status] == 'behind'
+            end
+          }
+          config.start_version = release[:tag_name].sub /#{config.tag_prefix}/, ''
+        rescue StandardError
+          log.error "No published releases found in #{config.repo} for branch #{config.branch}. Specify a start version explicitly."
+          exit 1
+        end
+      end
+    end
+
+    def get_date_for_version(tags, version)
+      # From the tags, find the tag for the specified version and get its sha
+      tagname = "#{config.tag_prefix}#{version}"
+      tag = tags.select {|tag| tag.name == tagname }.shift
+      tag.nil? and log.error "No commit found with tag name #{tagname}\n" and exit 1
+      tag_sha = tag[:commit][:sha]
+
+      # get the commit for that sha, and the date for that commit.
+      commit = git_client.commit( config.repo, tag_sha )
+      commit[:commit][:author][:date]
+    end
+
+    def get_commits_for_versions
+
+      # The github api does not directly support getting a list of commits since a tag was applied.
+      # To work around this, we instead:
+
+      # get a list of tags
+      tags = git_client.tags(config.repo)
+      # get the corresponding date for the tag corresponding to the start version
+      start_date = get_date_for_version tags, config.start_version
+      if config.end_version.nil?
+        # and get a list of commits since the start_date on the configured branch
+        commits = git_client.commits_since( config.repo, start_date, config.branch)
+        log.info "Got #{commits.length} commits on #{config.branch} between #{config.start_version}(#{start_date}) and now"
+      else
+        # and for the end version if not nil
+        end_date = get_date_for_version tags, config.end_version
+        # and get a list of commits between the start/end dates on the configured branch
+        commits = git_client.commits_between( config.repo, start_date, end_date, config.branch)
+        log.info "Got #{commits.length} commits on #{config.branch} between #{config.start_version}(#{start_date}) and #{config.end_version}(#{end_date})"
+      end
+      log.debug "Commits: " + commits.map(&:sha).join(',')
+      commits
+    end
+
+    def get_prs_for_commits(commits)
+      # To optimize the number of calls to github, we'll combine commits into fewer search
+      # calls, taking care not to exceed maximum query size of 256 chars
+
+      # Searches need to restrict to merged pull requests in the specified repo
+      search_suffix = " is:merged repo:#{config.repo}"
+      # Max commits that can fit into a single query, including ',' join delimiter
+      max_commits_per_search = 256/(config.min_sha_size + 1)
+
+      shas = commits.map { |commit| commit[:sha][0..(config.min_sha_size-1)] }
+      prs = shas.each_slice(max_commits_per_search).reduce([]) { |prs, sha_slice|
+        # We slice the list of commits into sublists that'll fit into the github query size limits
+        query = sha_slice.join(',') + search_suffix
+        results = git_client.search_issues( query )
+        log.info "Query '#{query}' matched #{results[:total_count]} PRs"
+        # the reduce method allows us to accummulate PRs, skipping any
+        prs.concat(results[:items])
+      }
+      # Dedupe prs
+      prs.uniq! { |pr| pr[:number] }
+      log.info "Retrieved #{prs.size} unique PRs"
+      prs.each {|pr| log.debug pr[:title]}
+      prs
+    end
+
+    def get_releasenotes_for_prs(prs)
+      notes = prs.reduce([]) { |notes, pr|
+        # Get release notes section
+        body = pr[:body].strip.slice(config.relnotes_regex, config.relnotes_group)
+        unless body.nil?
+          # Release notes exist for this PR, so do some cleanup
+          body.gsub! /^<!--.+?(?=-->)-->/m, '' # strip off (multiline) comments
+          body.gsub! /^\r?\n/, ''             # and empty lines
+        end
+        # For PRs without release notes, add just the title
+        notes << {:title => pr[:title], :date => pr[:closed_at], :prnum => pr[:number], :body => body}
+      }
+      notes.sort_by! {|note| note[:date]}.reverse! # order by PR merge date, newest first
+    end
+
+    def jiraize(notes_str)
+      unless config.jira_baseurl.nil?
+        # jira url is defined, so linkify any jira tickets in the notes
+        # Regex: negative lookbehind(?<!...) for jira_prefix or beginning of link markdown,
+        # followed by jira ticket pattern, followed by negative lookahead(?!...) for end of
+        # link markdown
+        #              |   neg lookbehind    |  | tkt pattern |  |neg lookahead|
+        notes_str.gsub!(/(?<!#{config.jira_baseurl}|\[)\b([A-Z]{2,}-\d+)\b(?![^\[\]]*\]\()/, "[\\1](#{config.jira_baseurl}\\1)")
+      end
+      notes_str
+    end
+
+    def get_notes_str(notes_by_pr)
+      notes_str = "Changes since #{config.tag_prefix}#{config.start_version}:\r\n"
+      if config.categorize
+        # Categorize the notes, using the regex as the category names
+        notes = notes_by_pr.reduce({}) { | notes, pr_note |
+          if pr_note[:body].nil?
+            # No explicit release notes
+            if config.include_all_prs
+              # Still want to include PR title under default category
+              note = "* #{pr_note[:title]} ([##{pr_note[:prnum]}](https://github.com/#{config.repo}/pull/#{pr_note[:prnum]} \"Merged #{pr_note[:date]}\"))\r\n"
+              # Initialize collapsible notes for category if it doesn't exist, and append note
+              (notes[config.category_default] ||= "<details><summary>Show/Hide</summary><p>\r\n\r\n") << note
+            end
+          else
+            # For each PR's notes, split by the category prefix
+            # The lookahead (?=) regex allows including the category prefix delimiter at the beginning of each split record
+            pr_note[:body].split(/(?=#{config.category_prefix})/).each { |pr_category_note|
+              # Assume all of the line after the category_prefix is the category name. Slice off the category prefix and extract the category name
+              category = pr_category_note.slice!(/#{config.category_prefix}[^\r]*/)
+              # Remove trailing newlines
+              pr_category_note.sub!(/^(\r\n)+|(\r\n)+$/, '')
+              # Generate section header using PR title
+              note = "* #{pr_note[:title]} ([##{pr_note[:prnum]}](https://github.com/#{config.repo}/pull/#{pr_note[:prnum]} \"Merged #{pr_note[:date]}\"))\r\n#{pr_category_note}\r\n"
+              # Use default category if no category found
+              category = category.nil? ? config.category_default : category.sub(/#{config.category_prefix}(.*)/,'\1')
+              # Initialize notes for category if it doesn't exist, and append note
+              (notes[category] ||= '') << note
+            }
+          end
+          notes
+        }
+        notes[config.category_default] << "</p></details>" unless notes[config.category_default].nil?   # Close the collapsible section
+        # Accumulate each category's notes
+        notes_str << notes.sort.map { |category, note|
+          note_str = category.nil? ? "#{config.relnotes_hdr_prefix}#{config.category_default}\r\n" : "#{config.relnotes_hdr_prefix}#{category}\r\n"
+          note_str << note
+        }.join("\r\n")
+      else
+        # No categorization required, use notes as is
+        notes_str << notes_by_pr.reduce("") { | str, note |
+          str << "#{config.relnotes_hdr_prefix}#{note[:title]} [##{note[:prnum]}](https://github.com/#{config.repo}/pull/#{note[:prnum]} \"Merged #{note[:date]}\")\r\n#{note[:body]}\r\n"
+        }
+      end
+      jiraize notes_str
+    end
+
+    def post_to_github(notes_str)
+      unless config.end_version.nil?
+        tag_name = "#{config.tag_prefix}#{config.end_version}"
+        begin
+          release = git_client.release_for_tag(config.repo, tag_name)
+          # Found existing release, so update it
+          log.info "Found existing #{release.draft? ? 'draft ' : ''}#{release.prerelease? ? 'pre-' : ''}release with tag #{tag_name} at #{release.html_url} with body: #{release.body}"
+          release = git_client.update_release(release.url, { :name => tag_name, :body => notes_str, :draft => false, :prerelease => true, :target_commitish => config.branch })
+          log.info "Updated pre-release #{release.id} at #{release.html_url} with body #{notes_str}"
+        rescue Octokit::NotFound
+          # no existing release, so create a new one
+          release = git_client.create_release(config.repo, tag_name, { :name => tag_name, :body => notes_str, :draft => false, :prerelease => true, :target_commitish => config.branch })
+          log.info "Created pre-release #{release.id} at #{release.html_url} with body #{notes_str}"
+        end
+      end
+    end
+
+  end
+
+end

data/pr_releasenotes.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pr_releasenotes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pr_releasenotes'
+  spec.version       = PrReleasenotes::VERSION
+  spec.version       = "#{spec.version}.#{ENV['TRAVIS_BUILD_NUMBER']}" \
+                          if ENV['TRAVIS'] && PrReleasenotes::VERSION.include?('.pre')
+  spec.authors       = ['arvindth']
+  spec.email         = ['arvind.thirunarayanan@bazaarvoice.com']
+
+  spec.summary       = %q{Post pull request based release notes to github releases}
+  spec.description   = %q{Generate release notes from pull request descriptions, and optionally post them to the github releases page}
+  spec.homepage      = 'https://github.com/bazaarvoice/pr_releasenotes'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'octokit', '~> 4.14'
+  spec.add_dependency 'to_regexp', '~> 0.2.1'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: pr_releasenotes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- arvindth
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.14'
+- !ruby/object:Gem::Dependency
+  name: to_regexp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description: Generate release notes from pull request descriptions, and optionally
+  post them to the github releases page
+email:
+- arvind.thirunarayanan@bazaarvoice.com
+executables:
+- pr_releasenotes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- OWNERS
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/custom_config.yaml
+- examples/custom_template.md
+- examples/default_config.yaml
+- exe/pr_releasenotes
+- lib/pr_releasenotes.rb
+- lib/pr_releasenotes/configuration.rb
+- lib/pr_releasenotes/version.rb
+- pr_releasenotes.gemspec
+homepage: https://github.com/bazaarvoice/pr_releasenotes
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Post pull request based release notes to github releases
+test_files: []