semantic_release 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a204e59fe728f22a01acf960d9d5d7098499df2bccad1bc49a6c92ea4029d2d
-  data.tar.gz: 471caaac5e1f4017ce564917554333d2da54aa7860522a700ffe3049e4be3e0d
+  metadata.gz: d3f71bfb1b22b3307bf77b825f38245da0a2fdb496a2283a177cce46b4ad06ac
+  data.tar.gz: 6d3bc24a2263f8bd9d7f2d473858cd0134bc414e676425fb2b4119f764b89ec7
 SHA512:
-  metadata.gz: 6ac502eeddea51f3947de0cba72763db2d51d44a00eb1edec413d79f4501c67696453220aa1914da165bfc78381c390d2dcc40e1578e2d1219f80b2924a74c52
-  data.tar.gz: 6cfbffd0d594fdc00377f8010f957d292b57866f53117288be79ea63616c7dc660e9d37afad881a90e735e3abc13569776f40e7a4599709268adbdef95abf506
+  metadata.gz: b66514f271a7e5fd91203815f754b05c00b390ce71bfc5fac1b2c2e4809661ef8a4db47d035c7c46e77039d588eae90160df703cf2b80a55273be374656968f5
+  data.tar.gz: be07bc941cd8ed5ae69a55fdb442a98a04a58553c68c3f69219bac9fc2662f27902767da0576cb7137ab920484837b3e77088043d6033adfc3974834a18eee0e

data/CHANGELOG.md

@@ -1,19 +1,29 @@
-## 1.2.0 (06 February 2025)
+## v1.3.0 (10 February 2025)
+
+- feat: Add config option to hide message about building and pushing the .gem file to rubygems.org
+- fix: Prefix version number in changelog files with 'v'
+- ci: Add rake_announcer gem
+
+## v1.2.1 (06 February 2025)
+
+- docs: Fix release instructions to clarify that you need to push the tag _and_ run `rake release`
+
+## v1.2.0 (06 February 2025)
 
 - feat: Mention 'rake release' in git tag updater output if a gemspec file is present
 - feat: Stage Gemfile.lock after bumping version.rb if a gemspec file is present
 
-## 1.1.0 (03 February 2025)
+## v1.1.0 (03 February 2025)
 
 - Add check to prevent re-initialising if semver file already exists
 - Add configuration options for semver file
 - Change rake task namespace from `semantic_release` to `release` and make configurable
 
-## 1.0.1 (02 February 2025)
+## v1.0.1 (02 February 2025)
 
 - Add blank line after version number in changelog
 - Remove unnecessary files from gem
 
-## 1.0.0 (02 February 2025)
+## v1.0.0 (02 February 2025)
 
 - Initial release

data/README.md

@@ -48,6 +48,7 @@ The name of the rake task and other options are configurable like so:
 require "semantic_release/rake_task"
 SemanticRelease::RakeTask.new(:semver) do |config|
   config.semver_file = "semver.json"
+  config.disable_rubygems_message = true
 end
 ```
 
@@ -73,7 +74,9 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
-To release a new version, run `bundle exec rake semver:XXX` (replacing `XXX` with `major` or `minor` or `patch`), which will bump the version number and create a git tag for the version. Then run `bundle exec rake release`, which will push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To release a new version, run `bundle exec rake semver:XXX` (replacing `XXX` with `major` or `minor` or `patch`), which will bump the version number and create a git tag for the version. Then run `git push origin main --tags` to push the new tag.
+
+Then run `bundle exec rake release`, which will build and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/semantic_release/configuration.rb

@@ -2,10 +2,11 @@
 
 module SemanticRelease
   class Configuration
-    attr_accessor :semver_file
+    attr_accessor :semver_file, :disable_rubygems_message
 
     def initialize
       @semver_file = ".semver"
+      @disable_rubygems_message = false
     end
   end
 end

data/lib/semantic_release/updaters/base_updater.rb

@@ -11,6 +11,10 @@ module SemanticRelease
         Semver.load(semver_file).to_s
       end
 
+      def self.current_version_tag
+        "v#{current_version}"
+      end
+
       def self.semver_file
         SemanticRelease.configuration.semver_file
       end

data/lib/semantic_release/updaters/changelog.rb

@@ -18,7 +18,7 @@ module SemanticRelease
         heading_marker = filepath.end_with?(".rdoc") ? "==" : "##"
         content = File.read(filepath)
         File.open(filepath, "w") do |f|
-          f.puts("#{heading_marker} #{current_version} (#{Time.now.strftime("%d %B %Y")})\n\n")
+          f.puts("#{heading_marker} #{current_version_tag} (#{Time.now.strftime("%d %B %Y")})\n\n")
           f.print(content)
         end
       end

data/lib/semantic_release/updaters/git_tag.rb

@@ -3,16 +3,21 @@
 module SemanticRelease
   module Updaters
     class GitTag < BaseUpdater
+      # rubocop:disable Style/GuardClause
       def self.update
-        tag = "v#{current_version}"
-        msg = "Increment version to v#{current_version}"
+        tag = current_version_tag
+        msg = "Increment version to #{tag}"
 
         `git add #{semver_file} && git commit -m '#{msg}' && git tag #{tag} -a -m '#{Time.now}'`
 
         branch = `git rev-parse --abbrev-ref HEAD`.chomp
         puts "To push the new tag, use 'git push origin #{branch} --tags'"
-        puts "OR to push the tag and .gem file to rubygems.org use, 'bundle exec rake release'" if gemspec_present?
+
+        if gemspec_present? && !SemanticRelease.configuration.disable_rubygems_message
+          puts "To build and push the .gem file to rubygems.org use, 'bundle exec rake release'"
+        end
       end
+      # rubocop:enable Style/GuardClause
     end
   end
 end

data/lib/semantic_release/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SemanticRelease
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: semantic_release
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - David Bull
 bindir: exe
 cert_chain: []
-date: 2025-02-06 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies: []
 description: |
   This gem helps you to manage the version number of your application or library. It provides Rake tasks to