grape-swagger-rails 2.0.0 → 2.0.1

data/lib/grape-swagger-rails/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module GrapeSwaggerRails
-  VERSION = '2.0.0'
-  SWAGGER_UI_VERSION = '5.33.0'
+  VERSION = '2.0.1'
+  SWAGGER_UI_VERSION = '5.33.2'
 end

data/script/swagger_ui_release_notes

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Prints a pull request body listing the upstream Swagger UI releases after
+# FROM_VERSION up to and including TO_VERSION. Requires an authenticated `gh`.
+
+require 'json'
+require 'open3'
+require 'rubygems'
+
+REPO = 'swagger-api/swagger-ui'
+# GitHub rejects pull request bodies over 65536 characters.
+MAX_BODY = 60_000
+
+from_version = Gem::Version.new(ENV.fetch('FROM_VERSION').delete_prefix('v'))
+to_version = Gem::Version.new(ENV.fetch('TO_VERSION').delete_prefix('v'))
+
+output, status = Open3.capture2('gh', 'api', '--paginate', "repos/#{REPO}/releases?per_page=100", '--jq', '.[]')
+abort "Could not list #{REPO} releases." unless status.success?
+
+releases = output.each_line.map { |line| JSON.parse(line) }.select do |release|
+  next false if release['draft'] || release['prerelease']
+
+  version = Gem::Version.new(release['tag_name'].delete_prefix('v'))
+  version > from_version && version <= to_version
+rescue ArgumentError
+  false
+end
+releases.sort_by! { |release| Gem::Version.new(release['tag_name'].delete_prefix('v')) }.reverse!
+
+# Upstream heading levels vary between releases; nest the release title and its sections under "Swagger UI changes".
+def nest_headings(body)
+  title = true
+  body.gsub(/^#+ /) do
+    heading = title ? '### ' : '#### '
+    title = false
+    heading
+  end
+end
+
+def format_notes(release)
+  body = release['body'].to_s.gsub("\r\n", "\n").gsub(/\n{3,}/, "\n\n").strip
+  return "### [#{release['tag_name']}](#{release['html_url']})\n\nNo release notes." if body.empty?
+
+  # Avoid pinging upstream contributors.
+  nest_headings(body).gsub(%r{(?<![\w`\[/])@([\w-]+)}, '`@\1`')
+end
+
+compare_url = "https://github.com/#{REPO}/compare/v#{from_version}...v#{to_version}"
+body = <<~MARKDOWN
+  Updates bundled Swagger UI assets from `v#{from_version}` to `v#{to_version}` ([compare](#{compare_url})).
+
+  Generated by the scheduled Swagger UI update workflow.
+
+  ## Swagger UI changes
+MARKDOWN
+
+if releases.empty?
+  body << "\nNo release notes found. See the [compare view](#{compare_url}).\n"
+else
+  releases.each do |release|
+    notes = "\n#{format_notes(release)}\n"
+    if body.length + notes.length > MAX_BODY
+      body << "\nRelease notes truncated. See the [compare view](#{compare_url}) for the rest.\n"
+      break
+    end
+    body << notes
+  end
+end
+
+puts body

data/script/update_changelog

@@ -4,7 +4,8 @@
 path = ENV.fetch('CHANGELOG_PATH', 'CHANGELOG.md')
 number = ENV.fetch('PR_NUMBER')
 url = ENV.fetch('PR_URL')
-author = ENV.fetch('PR_AUTHOR')
+# danger-changelog only accepts [\w-]+ author names, so `github-actions[bot]` becomes `github-actions`.
+author = ENV.fetch('PR_AUTHOR').delete_suffix('[bot]')
 author_url = ENV.fetch('PR_AUTHOR_URL')
 title = ENV.fetch('PR_TITLE').gsub(/\s+/, ' ').strip.sub(/\.+\z/, '')
 title = title.gsub(/([\[\]])/, '\\\\\1')
@@ -12,7 +13,13 @@ title = title.gsub(/([\[\]])/, '\\\\\1')
 entry = "* [##{number}](#{url}): #{title} - [@#{author}](#{author_url})."
 changelog = File.read(path)
 
-exit if changelog.lines.any? { |line| line.start_with?("* [##{number}](") }
+existing = changelog.lines.find { |line| line.start_with?("* [##{number}](") }
+if existing
+  # Leave hand-edited entries alone; only repair ones Danger would reject.
+  exit if existing.match?(%r{ - \[@[\w-]+\]\(https://github\.com/\S*[\w-]\)\.$})
+  File.write(path, changelog.sub(existing, "#{entry}\n"))
+  exit
+end
 
 next_release = /^### Next Release\s*$/
 placeholder = /^\* Your contribution here\.\s*$/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Alexander Logunov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-02 00:00:00.000000000 Z
+date: 2026-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml-rails
@@ -142,6 +142,7 @@ files:
 - lib/script/rails
 - lib/tasks/swagger_ui.rake
 - package.json
+- script/swagger_ui_release_notes
 - script/update_changelog
 - spec/dummy/.gitignore
 - spec/dummy/Rakefile
@@ -191,7 +192,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape-swagger-rails/issues
   changelog_uri: https://github.com/ruby-grape/grape-swagger-rails/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/ruby-grape/grape-swagger-rails/tree/v2.0.0
+  source_code_uri: https://github.com/ruby-grape/grape-swagger-rails/tree/v2.0.1
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []