semantic_release 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d133cd1d7514d3bc760404c01c9f8c38bece8a1bc874971638af935f3d77ffbe
-  data.tar.gz: 293b1d715a36d1c9d72395b4253706f204bb5ec56a2b189f231673af82ba16c4
+  metadata.gz: a55331e98f6d84634c6bbc2a629737890a88e9e7ad17a533928f74feb725c621
+  data.tar.gz: 9f026fe48e630dc6d43349ed0db545bc736c8ae6ff09abd7d872a5689fcbeba8
 SHA512:
-  metadata.gz: 4552fc1d77cf4b3d36190b465082ecb1f2e21c5ef5598f36f5afb995f477afe77745fdc30f6747ae9bce1d7f103066cdd1ca3e5726b8bb3d0c2d002577afa223
-  data.tar.gz: 8d10bcd1f380f5a885396437d055bdf52e75936472a26f63a55bb3668c19aecb40dc22206a3778c15c852d42798f660bd21092080488f39d7856fab6856d0133
+  metadata.gz: f0bd2de32e63c96e7373d797797ec977ac44d3533b60658aaff6be0edca37cee72790081ded9b0327745478a547e127c6bae61b8699b6ba89b9d4546bcd703f2
+  data.tar.gz: e7545da7de6ccc9f8df6e4d9adf550b29f3e764d1741ce189e421ec746ca4ea1a8bf93f6ca4f79de752f45007edd58ee3052385ca4fb23fe2469ce781543ce92

data/CHANGELOG.md

@@ -1,2 +1,14 @@
+## 1.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)
+
+- Add blank line after version number in changelog
+- Remove unnecessary files from gem
+
 ## 1.0.0 (02 February 2025)
+
 - Initial release

data/README.md

@@ -5,7 +5,7 @@ This gem helps you to manage the version number of your application or library.
 Use the provided Rake tasks to:
 
 - bump the major, minor, or patch number of your version
-- automatically update our verison file (e.g. `lib/version.rb`)
+- automatically update your version file (e.g. `lib/version.rb`)
 - automatically update your changelog (`CHANGELOG.md` or `history.rdoc`)
 - automatically create a git commit and tag for the release
 
@@ -38,14 +38,23 @@ require "semantic_release/rake_task"
 SemanticRelease::RakeTask.new
 ```
 
+The name rake tasks and other options are configurable like so:
+
+```ruby
+require "semantic_release/rake_task"
+SemanticRelease::RakeTask.new(:semver) do |config|
+  config.semver_file = "semver.json"
+end
+```
+
 The following tasks are available:
 
 ```
-rake semantic_release:init
-rake semantic_release:current
-rake semantic_release:major
-rake semantic_release:minor
-rake semantic_release:patch
+rake release:init
+rake release:current
+rake release:major
+rake release:minor
+rake release:patch
 ```
 
 To get the current version inside your application:

data/lib/semantic_release/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SemanticRelease
+  class Configuration
+    attr_accessor :semver_file
+
+    def initialize
+      @semver_file = ".semver"
+    end
+  end
+end

data/lib/semantic_release/rake_task.rb

@@ -5,11 +5,13 @@ require "semantic_release"
 
 module SemanticRelease
   class RakeTask < Rake::TaskLib
-    # rubocop:disable Metrics/MethodLength
-    def initialize
-      super
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def initialize(name = :release)
+      super()
 
-      namespace :semantic_release do
+      yield(SemanticRelease.configuration) if block_given?
+
+      namespace name do
         desc "Initialise version file"
         task :init do
           SemanticRelease.init
@@ -36,6 +38,6 @@ module SemanticRelease
         end
       end
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
   end
 end

data/lib/semantic_release/updaters/base_updater.rb

@@ -12,7 +12,7 @@ module SemanticRelease
       end
 
       def self.semver_file
-        SemanticRelease::SEMVER_FILE
+        SemanticRelease.configuration.semver_file
       end
     end
   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")
+          f.puts("#{heading_marker} #{current_version} (#{Time.now.strftime("%d %B %Y")})\n\n")
           f.print(content)
         end
       end

data/lib/semantic_release/version.rb

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

data/lib/semantic_release.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "semantic_release/configuration"
 require_relative "semantic_release/semver"
 require_relative "semantic_release/version"
 Dir[File.join(__dir__, "semantic_release", "updaters", "*.rb")].each { |file| require file }
@@ -7,15 +8,19 @@ Dir[File.join(__dir__, "semantic_release", "updaters", "*.rb")].each { |file| re
 module SemanticRelease
   class Error < StandardError; end
 
-  SEMVER_FILE = ".semver"
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
 
   def self.init
+    raise Error, "#{configuration.semver_file} already exists" if File.exist?(configuration.semver_file)
+
     version = Semver.new
-    version.save(SEMVER_FILE)
+    version.save(configuration.semver_file)
   end
 
   def self.current_version
-    Semver.load(SEMVER_FILE).to_s
+    Semver.load(configuration.semver_file).to_s
   end
 
   def self.inc_major
@@ -34,7 +39,7 @@ module SemanticRelease
   end
 
   def self.increment(term)
-    version = Semver.load(SEMVER_FILE)
+    version = Semver.load(configuration.semver_file)
     version.increment(term)
     version.save
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: semantic_release
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - David Bull
 bindir: exe
 cert_chain: []
-date: 2025-02-02 00:00:00.000000000 Z
+date: 2025-02-03 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
@@ -18,14 +18,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- ".semver"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/semantic_release.rb
+- lib/semantic_release/configuration.rb
 - lib/semantic_release/rake_task.rb
 - lib/semantic_release/semver.rb
 - lib/semantic_release/updaters/base_updater.rb

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,19 +0,0 @@
-require:
-  - rubocop-rake
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 3.1
-  NewCops: enable
-
-Layout/LineContinuationLeadingSpace:
-  EnforcedStyle: leading
-
-Style/Documentation:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes

data/.semver

@@ -1 +0,0 @@
-{"major":1,"minor":0,"patch":0}

data/Rakefile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-RuboCop::RakeTask.new
-
-require_relative "lib/semantic_release/rake_task"
-SemanticRelease::RakeTask.new
-
-task default: %i[spec rubocop]