Merge pull request #197 from ruby-go-gem/feature/changelog_generator

Create release on GitHub Actions

Author: sue445

.github/release.yml

@@ -0,0 +1,29 @@
+name: Create releases
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      - name: Generate changelog
+        run: |
+          bundle exec rake changelog[,${TAG_NAME}] > /tmp/changelog.md
+        env:
+          TAG_NAME: ${{ github.ref_name }}
+
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: /tmp/changelog.md

.github/workflows/release.yml

@@ -14,6 +14,15 @@ task :release do
   end
 end
 
+desc "Generate changelog entry"
+task :changelog, [:before, :after] do |_, params|
+  args = []
+  args << "--before #{params.before}" if params.before
+  args << "--after #{params.after}" if params.after
+
+  sh "ruby _tools/changelog_generator/changelog_generator.rb #{args.join(" ")}"
+end
+
 task build_all: %w[ruby:build_all go:build_all go_gem:test ruby_h_to_go:test patch_for_go_gem:test]
 
 task default: :build_all

Rakefile

@@ -0,0 +1,15 @@
+# changelog_generator
+Generate changelog entry
+
+## Requirements
+* Ruby
+* git
+* [gh](https://github.com/cli/cli)
+
+## Usage
+```bash
+$ ruby changelog_generator.rb --help
+Usage: changelog_generagtor [options]
+        --before=BEFORE              Before tag or sha1 (default: latest tag)
+        --after=AFTER                After tag or sha1 (default: HEAD)
+```

_tools/changelog_generator/README.md

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "json"
+
+# @return [String]
+def search_git_tags
+  `git tag`.each_line.map(&:strip).sort_by { |tag| Gem::Version.create(tag.delete_prefix("v")) }.reverse
+end
+
+# @param before [String]
+# @param after [String]
+# @return [Array<Integer>]
+def search_pr_numbers(before:, after:)
+  commits = `git rev-list --merges --right-only #{before}...#{after}`.each_line.map(&:strip)
+  commits.map do |commit|
+    commit_message = `git show -q #{commit}`
+    commit_message =~ /Merge pull request #([0-9]+)/
+    Regexp.last_match(1).to_i
+  end
+end
+
+before = nil
+after = nil
+
+opt = OptionParser.new
+opt.on("--before=BEFORE", "Before tag or sha1 (default: latest tag)") { |v| before = v }
+opt.on("--after=AFTER", "After tag or sha1 (default: HEAD)") { |v| after = v }
+
+opt.parse!(ARGV)
+
+after ||= "HEAD"
+
+unless before
+  git_tags = search_git_tags
+
+  if after == "HEAD"
+    # Use latest tag
+    before = git_tags[0]
+  else
+    index = git_tags.index(after)
+    before =
+      if index
+        # Use 1 previous tag of index
+        git_tags[index + 1]
+      else
+        # Use latest tag
+        git_tags[0]
+      end
+  end
+end
+
+pr_numbers = search_pr_numbers(before:, after:)
+all_prs = pr_numbers.map do |pr_number|
+  pr = JSON.parse(`gh pr view --json number,title,author,labels,url #{pr_number}`)
+  pr["label_names"] = pr["labels"].map { |label| label["name"] }
+  pr
+end
+
+# @param prs [Array<Hash>]
+#
+# @return [String]
+def generate_category_changelog(prs) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+  lines = []
+  found_pr_numbers = []
+  prs = prs.dup
+
+  ["breaking change", "bug", "enhancement"].each do |label|
+    label_prs = prs.find_all { |pr| pr["label_names"].include?(label) }
+
+    next if label_prs.empty?
+
+    case label
+    when "breaking change"
+      lines << "### :bomb: Breaking changes"
+    when "bug"
+      lines << "### Bugfixes"
+    when "enhancement"
+      lines << "### New Features"
+    end
+
+    label_prs.each do |pr|
+      lines < generate_changelog_line(pr)
+      found_pr_numbers << pr["number"]
+    end
+
+    found_pr_numbers.push(*label_prs.map { |pr| pr["number"] })
+
+    prs.reject! { |pr| found_pr_numbers.include?(pr["number"]) }
+
+    lines << ""
+  end
+
+  other_prs = prs.reject do |pr|
+    found_pr_numbers.include?(pr["number"]) || pr["label_names"].include?("chore")
+  end
+
+  lines << "### Other changes"
+  other_prs.each do |pr|
+    lines << generate_changelog_line(pr)
+  end
+  found_pr_numbers.push(*other_prs.map { |pr| pr["number"] })
+  lines << ""
+
+  return "* No changes\n\n" if found_pr_numbers.empty?
+
+  "#{lines.join("\n")}\n"
+end
+
+# @param pull_request [Hash]
+#
+# @return [String]
+def generate_changelog_line(pull_request)
+  author = pull_request["author"]["login"].delete_prefix("app/")
+
+  "* #{pull_request["title"]} by @#{author} in #{pull_request["url"]}"
+end
+
+changelog_body = +""
+
+changelog_body << "## Go\n"
+go_prs = all_prs.find_all { |pr| pr["label_names"].include?("go") }
+changelog_body << generate_category_changelog(go_prs)
+
+changelog_body << "## Ruby\n"
+ruby_prs = all_prs.find_all { |pr| pr["label_names"].include?("ruby") }
+changelog_body << generate_category_changelog(ruby_prs)
+
+changelog_body << "## ruby_h_to_go\n"
+ruby_h_to_go_prs = all_prs.find_all { |pr| pr["label_names"].include?("ruby_h_to_go") }
+changelog_body << generate_category_changelog(ruby_h_to_go_prs)
+
+changelog_body << "## Other\n"
+other_prs = all_prs.reject { |pr| pr["label_names"].any? { |label| %w[go ruby ruby_h_to_go chore].include?(label) } }
+changelog_body << generate_category_changelog(other_prs)
+
+changelog_body << "**Full Changelog**: https://github.com/ruby-go-gem/go-gem-wrapper/compare/#{before}...#{after}"
+
+puts changelog_body