changelogerator 0.0.14 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15c0df34a0b84def4982a8245b7d2fea66d52092941ecfcf761b5c55173670d8
-  data.tar.gz: c196735034e5aedbbff42ef8b8d822c434baed96c518ad6bedc8f6f61f864fbd
+  metadata.gz: 8b7471810cc9cef7c45a8e3e299797131a6535eb3719160b27911f622ed9edc3
+  data.tar.gz: 7ba7b175da8540b9faefba07510736f484380ae698aa910480c69de4647220c5
 SHA512:
-  metadata.gz: bb8aaaa63b3cea0adc294b6f02a8a21cffdd7dc52e9ef0c3cf4ee46ea06e30535229c8b9a738b03369fb8b87775169c29c4bf46580b97ceba786483849711ded
-  data.tar.gz: 35952f39e680721b3405aed8d7ce30947c6fc92e41d86942a6fc580a3d856af4ee8682aa8d6b56f7a9d903693346ecfd71e086f59fd7f360730a89a1aba15504
+  metadata.gz: c1b900314ed34b4b90de73ad40ebc946aa4e60f40fc3ed9801ad840088739b654452fbe226cf9233bcb881cec2bc7e742c431554cbb2b81209decc769bb2acf9
+  data.tar.gz: b413918b6710e7504f7ac1c750a1bdd1c00788f744c3168e25ff0ba85e1b6c13d985d368b3e50da8d872f047c3e072f6a656dbbda69e0e5a3749d2fe973ce02e

data/bin/changelogerator

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'optparse'
+require_relative '../lib/changelogerator'
+require 'logger'
+
+@options = {
+  from: nil,
+  to: nil
+}
+
+logger = Logger.new($stdout)
+logger.level = Logger::WARN
+logger.debug('Starting')
+
+OptionParser.new do |opts|
+  opts.banner = 'Changelogerator
+
+This utility helps generate a template friendly context made
+of the changes between 2 references on your Github project.
+
+  Usage:
+  changelogerator <repo> [options]'
+
+  opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
+    @options[:verbose] = v
+  end
+
+  opts.on('-fFROM', '--from=FROM', 'From Ref.') do |f|
+    @options[:from] = f
+  end
+
+  opts.on('-tTO', '--to=TO', 'To Ref.') do |t|
+    @options[:to] = t
+  end
+
+  opts.on('-p', '--[no-]prefix', 'Add (or not) a prefix for the repo') do |p|
+    @options[:prefix] = p
+  end
+
+  opts.on('-h', '--help', 'Prints this help') do
+    puts opts
+    exit
+  end
+end.parse!
+
+@options[:repo] = ARGV[0]
+
+def validate
+  raise "Missing value for the 'repo' field" unless @options[:repo]
+  raise "Missing value for the 'from' field" unless @options[:from]
+  raise "Missing value for the 'to' field" unless @options[:to]
+
+  true
+end
+
+exit 1 unless validate
+
+logger.debug('Validation passed')
+logger.debug(format(' - repo: %s', @options[:repo]))
+logger.debug(format(' - from: %s', @options[:from]))
+logger.debug(format(' - to: %s', @options[:to]))
+
+cl = Changelog.new(
+  @options[:repo],
+  @options[:from],
+  @options[:to],
+  token: ENV['GITHUB_TOKEN'],
+  prefix: @options[:prefix]
+)
+
+puts cl.to_json

data/lib/changelogerator.rb

@@ -3,52 +3,15 @@
 # A small wrapper class for more easily generating and manipulating Github/Git
 # changelogs. Given two different git objects (sha, tag, whatever), it will
 # find all PRs that made up that diff and store them as a list. Also allows
-# for filtering by label, and the importance of that change (priorities), based
+# for filtering by label, and the importance of that change (labels), based
 # on how we classify the importance of PRs in the paritytech/polkadot project.
-# Probably not tremendously useful to other projects.
 class Changelog
   require 'octokit'
   require 'git_diff_parser'
+  require 'json'
 
-  attr_accessor :changes
-  attr_reader :priority
-
-  @priorities = [
-    {
-      priority: 1,
-      label: 'C1-low 📌',
-      text: 'Upgrade priority: **Low** (upgrade at your convenience)'
-    },
-    {
-      priority: 3,
-      label: 'C3-medium 📣',
-      text: 'Upgrade priority: **Medium** (timely upgrade recommended)'
-    },
-    {
-      priority: 7,
-      label: 'C7-high ❗️',
-      text: 'Upgrade priority:❗ **HIGH** ❗ Please upgrade your node as soon as possible'
-    },
-    {
-      priority: 9,
-      label: 'C9-critical ‼️',
-      text: 'Upgrade priority: ❗❗ **URGENT** ❗❗ PLEASE UPGRADE IMMEDIATELY'
-    }
-  ]
-
-  class << self
-    attr_reader :priorities
-  end
-
-  # Return highest priority from an array of changes (NOT the actual Changelog
-  # object)
-  def self.highest_priority_for_changes(changes)
-    @priorities.find do |p|
-      p[:priority] == changes.map do |change|
-        change[:priority][:priority]
-      end.max
-    end
-  end
+  attr_accessor :repository, :changes, :meta
+  attr_reader :label
 
   def self.changes_with_label(changes, label)
     changes.select do |change|
@@ -56,6 +19,32 @@ class Changelog
     end
   end
 
+  # Go through all changes and compute some
+  # aggregated values
+  def compute_global_meta
+    @meta = {}
+
+    @changes.each do |change|
+      # here we remove some of the fields to reduce (considerably) the size
+      # of the json output
+      change.head = nil
+      change.base = nil
+      change._links = nil
+
+      change[:meta].each_key do |meta_key|
+        current = change[:meta][meta_key]
+
+        meta[meta_key] = {} unless meta[meta_key]
+        meta[meta_key][:min] = current[:value] if !meta[meta_key][:min] || current[:value] < meta[meta_key][:min]
+        meta[meta_key][:max] = current[:value] if !meta[meta_key][:max] || current[:value] > meta[meta_key][:max]
+        meta[meta_key][:count] = 0 unless meta[meta_key][:count]
+        meta[meta_key][:count] += 1
+      end
+    end
+  end
+
+  # Return the list of all the files in the changeset
+  # that also in the given path
   def self.changes_files_in_paths?(change, paths)
     changed_files = GitDiffParser.parse(Octokit.get(change.diff_url)).files
     paths = [paths] unless paths.is_a? Array
@@ -65,6 +54,18 @@ class Changelog
     nil
   end
 
+  # Return the label code for a change
+  # if the label name matches the expected pattern.
+  # nil otherwise.
+  def self.get_label_code(name)
+    m = match = name.match(/^([a-z])(\d+)-(.*)$/i)
+    if m
+      letter, number, text = match.captures
+      return [letter, number, text]
+    end
+    nil
+  end
+
   ## End of class methods
 
   # github_repo: 'paritytech/polkadot'
@@ -76,44 +77,72 @@ class Changelog
   # prefix: whether or not to prefix PR numbers with their repo in the changelog
   def initialize(github_repo, from, to, token: '', prefix: nil)
     @repo = github_repo
-    @priorities = self.class.priorities
     @gh = Octokit::Client.new(
       access_token: token
     )
+    @repository = @gh.repository(@repo)
     @prefix = prefix
-    @changes = prs_from_ids(pr_ids_from_git_diff(from, to)).map(&:to_hash)
-    # add priority to each change
-    @changes.map { |c| apply_priority_to_change(c) }
-  end
-
-  def changes_with_label(label)
-    self.class.changes_with_label(@changes, label)
-  end
+    ids = pr_ids_from_git_diff(from, to)
+    @changes = prs_from_ids(ids)
+    @changes.map do |c|
+      compute_change_meta(c)
+    end
 
-  def runtime_changes?
-    nil
+    compute_global_meta
   end
 
   def add(change)
-    changes.prepend(prettify_title(apply_priority_to_change(change)))
+    compute_change_meta(change)
+    prettify_title(change)
+    changes.prepend(change)
+    @meta = compute_global_meta
   end
 
+  # Add a pull request from id
   def add_from_id(id)
     pull = @gh.pull_request(@repo, id)
     add pull
   end
 
+  def to_json(*_args)
+    opts = {
+      array_nl: "\n",
+      object_nl: "\n",
+      indent: '  ',
+      space_before: ' ',
+      space: ' '
+    }
+    obj = @changes
+
+    commits = {
+      meta: @meta,
+      repository: @repository.to_h,
+      changes: obj.map(&:to_h)
+    }
+
+    JSON.fast_generate(commits, opts)
+  end
+
   private
 
-  def apply_priority_to_change(change)
-    @priorities.each do |p|
-      change[:priority] = p if change[:labels].any? { |l| l[:name] == p[:label] }
+  # Compute and attach metadata about one change
+  def compute_change_meta(change)
+    meta = {}
+
+    change.labels.each do |label|
+      letter, number, text = self.class.get_label_code(label.name)
+      next unless letter && number
+
+      meta[letter] = {
+        value: number.to_i,
+        text: text
+      }
     end
-    # Failsafe: add lowest priority if none detected
-    change[:priority] ||= @priorities[0]
-    change
+
+    change['meta'] = meta
   end
 
+  # Prepend the repo if @prefix is true
   def prettify_title(pull)
     pull[:pretty_title] = if @prefix
                             "#{pull[:title]} (#{@repo}##{pull[:number]})"
@@ -124,11 +153,13 @@ class Changelog
   end
 
   def pr_ids_from_git_diff(from, to)
-    @gh.compare(@repo, from, to).commits.map do |c|
+    commits = @gh.compare(@repo, from, to).commits
+    commits.map do |c|
       title = c.commit.message.split("\n\n").first
-      next unless title =~ /\(#[0-9]+\)$/
+      regex = /.*#([0-9]+).*$/
+      next unless title =~ regex
 
-      title.gsub(/.*#([0-9]+)\)$/, '\1')
+      title.gsub(regex, '\1')
     end.compact.map(&:to_i)
   end
 

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: changelogerator
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.9.1
 platform: ruby
 authors:
 - Martin Pugh
+- Wilfried Kopp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git_diff_parser
@@ -38,12 +39,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
-description: Simple helper class for paritytech/polkadot changelogs
+description: A utility to fetch the data required to generate a changelog based on
+  change in Github and formatted labels.
 email:
-executables: []
+executables:
+- changelogerator
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/changelogerator
 - lib/changelogerator.rb
 homepage: https://github.com/s3krit/changelogerator
 licenses:
@@ -57,14 +61,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Changelog generation/management