gem_hadar 2.18.0 → 2.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a611c21e21c49be5ed37e09624d8036474e19bdb3a49de0f9ae4d75a4bba8f4
-  data.tar.gz: 883a417418e398cc78d3e8828ef79a2ca427a2638cd83ad3251aebf78dc614f5
+  metadata.gz: fa1210ad135557e6e4a436f81fbed3e7f0529948e83ee43e61389f5174b9b60f
+  data.tar.gz: e3e51b44c6c88125d196219ecd9be87114745cb505f24960849ba33ada20ce64
 SHA512:
-  metadata.gz: e203cadc253ab29fbb576b907b7e0b74962e3ab5fcad832a7a598ce9572407b136350ce80fd0d7ec503960d4f713134f82cdedf2309c3c96c1d51bab877de900
-  data.tar.gz: '08075104eb3b809ce859fb56564442a2479603c290d58e7c53869c8a713715dec5fece3159d39768dfef51689f568a53f0004b0c97f12782accc614f5e01ed95'
+  metadata.gz: e81e0dfa1100249bdff83845f5cffe2e3e54355567d02bc95963e55b6a3b1e715d56d3d82c38b48e40423aa483f131b5f209bd8a8eaefc96a821e08bc93f7382
+  data.tar.gz: ca57360e525ffffd232b317862833b2a3063573bfb3652f10c64c91afa5827386c883cb0821eb4ddadd10093f85e7c03c32fc50cb58b32dfb6702c75a551a132

data/gem_hadar.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: gem_hadar 2.18.0 ruby lib
+# stub: gem_hadar 2.19.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gem_hadar".freeze
-  s.version = "2.18.0".freeze
+  s.version = "2.19.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -17,13 +17,13 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/flori/gem_hadar".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "GemHadar - Library for the development of Ruby Gems".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "4.0.17".freeze
+  s.rubygems_version = "4.0.22".freeze
   s.summary = "Library for the development of Ruby Gems".freeze
   s.test_files = ["spec/gem_hadar_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.17.1".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.19.0".freeze])
   s.add_development_dependency(%q<all_images>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.13".freeze])
   s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])

data/lib/gem_hadar/changelog_generator.rb

@@ -52,10 +52,10 @@ class GemHadar
 
       range = "#{from.tag}..#{to.tag}"
 
-      log = `git log #{range}`
+      log = `git log --color=never -p #{range}`
       $?.success? or raise "Failed to get git log for range #{range}"
 
-      date = `git log -n1 --pretty='format:%cd' --date=short #{to.tag.inspect}`.chomp
+      date = `git log --color=never -n1 --pretty='format:%cd' --date=short #{to.tag.inspect}`.chomp
 
       if log.strip.empty?
         return "\n## #{date} #{to.without_prefix.to_s}\n"
@@ -129,7 +129,7 @@ class GemHadar
       end
 
       first_version = versions.first
-      date          = `git log -n1 --pretty='format:%cd' --date=short #{first_version.tag.to_s}`.chomp
+      date          = `git log --color=never -n1 --pretty='format:%cd' --date=short #{first_version.tag.to_s}`.chomp
       changelog     = ["\n## #{date} #{first_version.tag.to_s}\n\n* Start\n"]
 
       changelog = generate_changelog(versions, changelog:)
@@ -269,7 +269,7 @@ class GemHadar
     #   chronological order
     def generate_changelog(versions, changelog: [])
       versions = versions.each_cons(2).
-        with_infobar(total: versions.size - 1, label: 'Change')
+        with_infobar(total: versions.size - 1, label: 'Change', show: STDOUT.tty?)
       versions.each do |range_from, range_to|
         changelog << generate(range_from, range_to)
         +infobar

data/lib/gem_hadar/prompt_template.rb

@@ -34,25 +34,62 @@ module GemHadar::PromptTemplate
   # @return [ String ] the prompt template for GitHub release changelog generation
   def default_git_release_prompt
     <<~EOT
-      Output the content of a changelog this new release, but never mention
-      the version of the release.
+      Generate the release body for a new release from the following Git log
+      (commit messages and unified diffs):
 
-      **Strictly** follow these guidelines:
+      %{log_diff}
 
-        - Use bullet points in markdown format (`-`) to list significant changes.
-        - Exclude trivial updates such as:
-          * Version number increments
-          * Dependency version bumps (unless they resolve critical issues)
-          * Minor code style adjustments
-          * Internal documentation tweaks
-        - Include only verified and substantial changes that impact
-          functionality, performance, or user experience.
-        - If unsure about a change's significance, omit it from the output.
-        - Avoid adding any comments or notes; keep the output purely factual.
+      **Input:**
+      - Commit messages describe the author's intent.
+      - Patches show the actual code changes and are the source of truth.
+      - If a commit message is vague or misleading, trust the patch.
 
-      These are the log messages including patches for the new release:
+      **Rules:**
+      1. Categorize each change into one of the sections below.
+      2. **Omit any section that has zero entries. Do NOT output an
+         empty header with no bullet points beneath it.**
+      3. Never mention the version number of the release.
+      4. Include only significant changes that impact functionality,
+         performance, or user experience.
+      5. Exclude trivial updates:
+         - Version number increments
+         - Dependency version bumps (unless they resolve critical issues)
+         - Minor code style adjustments
+         - Internal documentation tweaks
+      6. Wrap variable, method, function, and constant names in backticks.
+      7. Wrap version numbers in **bold**.
+      8. Do NOT reference individual commits by SHA-1 hash.
+      9. Do NOT add chatty remarks, notes, introductions, or closing lines.
+      10. If unsure about a change's significance, omit it.
 
-      %{log_diff}
+      **Output format:**
+      - Use the section headers below. Omit empty sections entirely.
+
+      ### Breaking
+      API changes, removed features, or compatibility changes
+      that require user action.
+      - …
+
+      ### Features
+      New user-facing APIs, options, or capabilities.
+      - …
+
+      ### Fixes
+      - …
+
+      ### Improvements
+      - …
+
+      ### Build & CI
+      CI pipeline, Dockerfile, dependency, gemspec metadata,
+      test infrastructure, and tooling changes.
+      - …
+
+      ### Testing
+      - …
+
+      ### Documentation
+      - …
     EOT
   end
 
@@ -69,10 +106,10 @@ module GemHadar::PromptTemplate
   def default_version_bump_system_prompt
     <<~EOT
       You are an expert at semantic versioning. Analyze the provided changes
-      and suggest whether to bump major, minor, or build version according to
-      Semantic Versioning. Provide a brief explanation of your reasoning,
-      followed by a single line containing only one word: 'major', 'minor', or
-      'build'.
+      and suggest whether to bump major, minor, or build (=patch) version
+      according to Semantic Versioning. Provide a brief explanation of your
+      reasoning, followed by a single line containing only one word: 'major',
+      'minor', or 'build'.
     EOT
   end
 
@@ -109,8 +146,9 @@ module GemHadar::PromptTemplate
   # @return [ String ] the system prompt for changelog generation
   def default_changelog_system_prompt
     <<~EOT
-      You are a Ruby programmer generating a change log entry in markdown syntax,
-      summarizing the code changes for a new version in a professional way.
+      You are a Ruby programmer generating a changelog entry in markdown.
+      Summarize code changes for a new version in a professional, factual
+      tone. You are not a chatbot.
     EOT
   end
 
@@ -124,23 +162,57 @@ module GemHadar::PromptTemplate
   # while focusing on significant functional changes.
   def default_changelog_prompt
     <<~EOT
-      Generate a changelog entry for the following Git commit history:
+      Generate a changelog entry from the following Git log
+      (commit messages and unified diffs):
 
       %{log_diff}
 
-    - Summarize the changes in the following git log messages as bullet points.
-    - Don't mention the version of the change set
-    - Skip bullet points about version bumps.
-    - List significant changes as bullet points using markdown when applicable.
-    - Mark all names and values for variables, methods, functions, and
-      constants, you see in the messages  as markdown code surrounded by
-      backtick characters.
-    - Mark all version numbers you see in the messages as markdown bold
-     surrounded by two asterisk characters.
-    - Don't refer to single commits by sha1 hash.
-    - Don't add information about changes you are not sure about.
-    - Don't output any additional chatty remarks, notes, introductions,
-      communications, etc.
+      **Input:**
+      - Commit messages describe the author's intent.
+      - Patches show the actual code changes and are the source of truth.
+      - If a commit message is vague or misleading, trust the patch.
+
+      **Rules:**
+      1. Categorize each change into one of the sections below.
+      2. **Omit any section that has zero entries. Do NOT output an
+         empty header with no bullet points beneath it.**
+      3. Do NOT mention the version number of the change set.
+      4. Skip entries that are purely version bumps.
+      5. Wrap variable, method, function, and constant names found in
+         messages or patches in backticks.
+      6. Wrap version numbers found in messages in **bold**.
+      7. Do NOT reference individual commits by SHA-1 hash.
+      8. Do NOT add information you are not certain about.
+      9. Do NOT include chatty remarks, introductions, or closing notes.
+
+      **Output format:**
+      - Use the section headers below. Omit empty sections entirely.
+
+      ### Breaking
+      API changes, removed features, or compatibility changes
+      that require user action.
+      - …
+
+      ### Features
+      New user-facing APIs, options, or capabilities.
+      - …
+
+      ### Fixes
+      - …
+
+      ### Improvements
+      - …
+
+      ### Build & CI
+      CI pipeline, Dockerfile, dependency, gemspec metadata,
+      test infrastructure, and tooling changes.
+      - …
+
+      ### Testing
+      - …
+
+      ### Documentation
+      - …
     EOT
   end
 end

data/lib/gem_hadar/version.rb

@@ -1,6 +1,11 @@
+# Version information for the GemHadar gem.
+#
+# This module is auto-generated by GemHadar and exposes the
+# current release version as a set of constants. Do not edit it
+# by hand; it is rewritten on every `rake version` invocation.
 class GemHadar
-  # GemHadar version
-  VERSION         = '2.18.0'
+  # The current version of the GemHadar gem as a String.
+  VERSION         = '2.19.1'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/gem_hadar.rb

@@ -808,8 +808,13 @@ class GemHadar
       mkdir_p dir = File.join('lib', path_name)
       secure_write(File.join(dir, 'version.rb')) do |v|
         v.puts <<~EOT
+          # Version information for the #{path_module} gem.
+          #
+          # This #{module_type} is auto-generated by GemHadar and exposes the
+          # current release version as a set of constants. Do not edit it
+          # by hand; it is rewritten on every `rake version` invocation.
           #{module_type} #{path_module}
-            # #{path_module} version
+            # The current version of the #{path_module} gem as a String.
             VERSION         = '#{version}'
             VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
             VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
@@ -873,7 +878,7 @@ class GemHadar
           fail "Could not find #{from_version.inspect}."
         end
       end
-      `git log -p #{from_version.tag}..HEAD`
+      `git log --color=never -p #{from_version.tag}..HEAD`
     else
       unless versions.find { |v| v == to_version }
         fail "Could not find #{to_version.inspect}."
@@ -885,14 +890,14 @@ class GemHadar
           end
         end
         unless from_version
-          return `git log -p #{to_version.tag}`
+          return `git log --color=never -p #{to_version.tag}`
         end
       else
         unless versions.find { |v| v == from_version }
           fail "Could not find #{from_version.inspect}."
         end
       end
-      `git log -p #{from_version.tag}..#{to_version.tag}`
+      `git log --color=never -p #{from_version.tag}..#{to_version.tag}`
     end
   end
 
@@ -1378,8 +1383,16 @@ class GemHadar
   # @return [ String ] the generated changelog content for the release body
   def create_git_release_body
     log_diff = version_log_diff(to_version: version)
-    system   = xdg_config('gem_hadar', 'release_system_prompt.txt', default_git_release_system_prompt)
-    prompt   = xdg_config('gem_hadar', 'release_prompt.txt', default_git_release_prompt) % { name:, version:, log_diff: }
+    system   = xdg_config(
+      'gem_hadar',
+      'release_system_prompt.txt',
+      default_git_release_system_prompt
+    )
+    prompt   = xdg_config(
+      'gem_hadar', 'release_prompt.txt', default_git_release_prompt
+    ) % {
+      name:, version:, log_diff:
+    }
     ollama_generate(system:, prompt:)
   end
 
@@ -2171,8 +2184,9 @@ class GemHadar
   # - Applies template variables to customize the generated workflows
   def github_workflows_task
     namespace :github do
+      github_workflow_templates = create_github_workflow_templates
       desc "Create all configured github workflow tasks"
-      task :workflows => create_github_workflow_templates
+      task :workflows => github_workflow_templates
       namespace :workflows do
         desc "Delete all created github workflows"
         task :clean do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_hadar
 version: !ruby/object:Gem::Version
-  version: 2.18.0
+  version: 2.19.1
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.17.1
+        version: 2.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.17.1
+        version: 2.19.0
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -319,7 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 4.0.22
 specification_version: 4
 summary: Library for the development of Ruby Gems
 test_files: