From 774e9e000e8f56b5f6880d519d1479fd873b396d Mon Sep 17 00:00:00 2001
From: Mark Cooper <mark.c.cooper@outlook.com>
Date: Wed, 24 Jun 2020 16:50:50 -0700
Subject: [PATCH] Brief form for relnotes

---
 Rakefile                       |  5 +++--
 scripts/tasks/release_notes.rb | 38 +++++++++++++++++++++++-----------
 2 files changed, 29 insertions(+), 14 deletions(-)

diff --git a/Rakefile b/Rakefile
index ead202eb6d..d0778e2fd8 100644
--- a/Rakefile
+++ b/Rakefile
@@ -40,13 +40,14 @@ namespace :release_notes do
   # bundle exec rake release_notes:generate[$current_version,master]
   # bundle exec rake release_notes:generate[v2.7.1,master]
   desc 'Generate a release notes formatted document between commits'
-  task :generate, [:since, :target] do |_t, args|
+  task :generate, [:since, :target, :style] do |_t, args|
     target = args.fetch(:target, 'master')
+    style  = args.fetch(:style, 'brief')
     log = ReleaseNotes::GitLogParser.run(
       path: __dir__,
       since: args.fetch(:since, 'master'),
       target: target
     )
-    puts ReleaseNotes::Generator.new(version: target, log: log).process
+    puts ReleaseNotes::Generator.new(version: target, log: log, style: style).process
   end
 end
diff --git a/scripts/tasks/release_notes.rb b/scripts/tasks/release_notes.rb
index 85d5bdff31..eff0e04ce2 100644
--- a/scripts/tasks/release_notes.rb
+++ b/scripts/tasks/release_notes.rb
@@ -21,12 +21,12 @@ def self.run(path:, since:, target:)
         data[:desc] = desc
         log << data
       end
-      log
+      log.sort_by { |l| l[:pr_number].to_i }
     end
   end
 
   class Generator
-    attr_reader :contributors, :contributions, :doc, :log, :messages, :version
+    attr_reader :contributors, :contributions, :doc, :log, :messages, :style, :version
     ANW_URL = 'https://archivesspace.atlassian.net/browse'
     PR_URL  = 'https://github.com/archivesspace/archivesspace/pull'
     EXCLUDE_AUTHORS = [
@@ -37,21 +37,25 @@ class Generator
       'Mark Cooper',
       'dependabot[bot]'
     ]
-    def initialize(version:, log:)
-      @contributors = Hash.new(0)
+    def initialize(version:, log:, style:)
+      @contributors = {}
       @contributions = 0
       @doc = []
       @log = log
       @messages = []
+      @style = style
       @version = version
     end
 
     def process
       log.each do |data|
-        contributors[data[:author]] += 1 unless EXCLUDE_AUTHORS.include?(data[:author])
+        unless EXCLUDE_AUTHORS.include?(data[:author])
+          contributors[data[:author]] = [] unless contributors.key? data[:author]
+          contributors[data[:author]] << data[:desc]
+        end
         messages << format_log_entry(data)
       end
-      @contributions = contributors.values.reduce(:+)
+      @contributions = contributors.map{ |_, v| v.count }.reduce(:+)
       make_doc
       self
     end
@@ -70,9 +74,16 @@ def anw_link(anw_number)
 
     def format_log_entry(data)
       links = [pr_link(data[:pr_number]), anw_link(data[:anw_number])]
-      msg = "PR: #{links.compact.join(' - ')} "
-      msg += "by #{data[:author]} accepted on #{data[:date]}\n"
-      msg += "#{data[:desc]}\n"
+      msg = ''
+      if style == 'brief'
+        msg = "- PR: #{links.compact.join(' - ')}: #{data[:desc]}"
+      elsif style == 'verbose'
+        msg = "PR: #{links.compact.join(' - ')} "
+        msg += "by #{data[:author]} accepted on #{data[:date]}\n"
+        msg += "#{data[:desc]}\n"
+      else
+        raise "Invalid style: #{style}"
+      end
       msg
     end
 
@@ -88,10 +99,13 @@ def make_doc
 on or after **#{DateTime.now.next_year(1).to_date}**.  For more information see
 the [ArchivesSpace API documentation](https://archivesspace.github.io/archivesspace/api/).\n"
       doc << find_deprecations
+      doc << "## Other considerations (plugins etc.):\n"
+      doc << "__TODO: add anything else to call out here__\n"
       doc << "## Community Contributions\n"
-      doc << "Our thanks go out to these members of the community for their code contributions: \n"
-      doc.concat contributors.sort_by { |k, _| k }.map { |c| "- #{c[0]}: #{c[1]}" }
-      doc << ''
+      doc << "Our thanks go out to these members of the community for their code contributions:\n"
+      doc.concat contributors.sort_by { |k, _| k }.map { |c|
+        "- #{c[0]}:\n#{c[1].map { |c| "  - #{c}\n" }.join}"
+      }
       doc << "Total community contributions accepted: #{contributions}\n"
       doc << "## JIRA Tickets and Pull Requests Completed\n"
       doc.concat messages