changelogerator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 168c71f208452944f40001c41d2902d879c19b2f01e9a0a523d9d9a5b37def22
+  data.tar.gz: bd5d94e6d95e19eab2cb6b115ad286c6f8dd7e343f72646b79f6936e454978ef
+SHA512:
+  metadata.gz: 6b2ab20548258e78d78ac99deed1bc509f5bbf8bbbd062b141a92f86990d6e7d8261d108bc4a51091b9998808aefbed7388eb21b4da0045d3ecea430b7508865
+  data.tar.gz: 360a16cd39c8e224a3c0e66d6ad1d9b1d454cc1605b576acc91dd30c941ea2a23adbe4c653f70e3b02a58d73b4ba8d83891f30d5f5db20e6de2d74b6b95bc520

data/lib/changelogerator.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+# 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
+# on how we classify the importance of PRs in the paritytech/polkadot project.
+# Probably not tremendously useful to other projects.
+class Changelog
+  require 'github_api'
+
+  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
+
+  def self.changes_with_label(changes, label)
+    changes.select do |change|
+      change.labels.any? { |c| c[:name] == label } == true
+    end
+  end
+
+  ## End of class methods
+
+  # github_repo: 'paritytech/polkadot'
+  # from: some git ref e.g., 7e30258, v1.2.3
+  # to: some git ref e.g., 7e30258, v1.2.3
+  #
+  # Optional named parameters:
+  # token: a Github personal access token
+  # prefix: whether or not to prefix PR numbers with their repo in the changelog
+  def initialize(github_repo, from, to, token: '', prefix: nil)
+    org, repo = github_repo.split('/')
+    @ghr = github_repo
+    @priorities = self.class.priorities
+    @gh = Github.new do |c|
+      c.oauth_token = token
+      c.org = org
+      c.repo = repo
+    end
+    @changes = prs_from_ids(pr_ids_from_git_diff(from, to), prefix)
+    # 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
+
+  private
+
+  def apply_priority_to_change(change)
+    @priorities.each do |p|
+      change[:priority] = p if change.labels.any? { |l| l[:name] == p[:label] }
+    end
+    change
+  end
+
+  def pr_ids_from_git_diff(from, to)
+    @gh.repos.commits.compare(@gh.org, @gh.repo, from, to).body.commits.map do |l|
+      title = l.commit.message.split("\n\n").first
+      next unless title =~ /\(#[0-9]+\)$/
+
+      title.gsub(/.*#([0-9]+)\)$/, '\1')
+    end.compact
+  end
+
+  def prs_from_ids(ids, prefix)
+    prs = []
+    ids.each do |pr|
+      pull = @gh.pull_requests.get(@gh.org, @gh.repo, pr).body
+      pull[:pretty_title] = if prefix
+                              "#{pull[:title]} (#{@ghr}##{pull[:number]})"
+                            else
+                              "#{pull[:title]} (##{pull[:number]})"
+                            end
+      prs.push pull
+    end
+    prs
+  end
+end

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: changelogerator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Pugh
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-28 00:00:00.000000000 Z
+dependencies: []
+description: Simple helper class for paritytech/polkadot changelogs
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/changelogerator.rb
+homepage: https://github.com/s3krit/changelogerator
+licenses:
+- AGPL-3.0
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Changelog generation/management
+test_files: []