semantic_release 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91fc39f15e36b70debd6a5aef9b8046709d9a2afb9e67af57745e81a49b38968
-  data.tar.gz: b663616e65a61c83a84524927aff9277a5c28aee526dfba28e05972589aa1551
+  metadata.gz: 0a204e59fe728f22a01acf960d9d5d7098499df2bccad1bc49a6c92ea4029d2d
+  data.tar.gz: 471caaac5e1f4017ce564917554333d2da54aa7860522a700ffe3049e4be3e0d
 SHA512:
-  metadata.gz: a670190a1415055ce97e9271eb8937080096cbea25bcc92ad766f5d3699ce35912848f1bc7206dc308ee7489fe3ea3ef999dc417a61669bb260663358d64d93a
-  data.tar.gz: 7b761dfa2c043b381d0156843172d84bec9d7b48d7b5f6eefd161a200aa1d360cab1553ee2009ad30fd9ea443ad3971e80f4f5330a34684b96717db0d86ceee7
+  metadata.gz: 6ac502eeddea51f3947de0cba72763db2d51d44a00eb1edec413d79f4501c67696453220aa1914da165bfc78381c390d2dcc40e1578e2d1219f80b2924a74c52
+  data.tar.gz: 6cfbffd0d594fdc00377f8010f957d292b57866f53117288be79ea63616c7dc660e9d37afad881a90e735e3abc13569776f40e7a4599709268adbdef95abf506

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.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)
+
+- 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

data/README.md

@@ -1,11 +1,15 @@
 # SemanticRelease
 
+[![Build Status](https://github.com/ukdave/semantic_release/actions/workflows/main.yml/badge.svg)](https://github.com/ukdave/semantic_release/actions/workflows/main.yml)
+[![Release](https://img.shields.io/github/v/release/ukdave/semantic_release)](https://github.com/ukdave/semantic_release/releases)
+[![License](https://img.shields.io/github/license/ukdave/semantic_release)](https://github.com/ukdave/semantic_release/blob/main/LICENSE.txt)
+
 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 +42,23 @@ require "semantic_release/rake_task"
 SemanticRelease::RakeTask.new
 ```
 
+The name of the rake task 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:
@@ -58,7 +71,9 @@ SemanticRelease.current_version
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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).
 
 ## Contributing
 

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,11 @@ module SemanticRelease
       end
 
       def self.semver_file
-        SemanticRelease::SEMVER_FILE
+        SemanticRelease.configuration.semver_file
+      end
+
+      def self.gemspec_present?
+        !Dir.glob("*.gemspec").empty?
       end
     end
   end

data/lib/semantic_release/updaters/gemfile_lock.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SemanticRelease
+  module Updaters
+    class GemfileLock < BaseUpdater
+      def self.update
+        return unless gemspec_present?
+        return if system("git check-ignore -q Gemfile.lock")
+
+        `bundle check && git add Gemfile.lock`
+      end
+    end
+  end
+end

data/lib/semantic_release/updaters/git_tag.rb

@@ -11,6 +11,7 @@ module SemanticRelease
 
         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?
       end
     end
   end

data/lib/semantic_release/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SemanticRelease
-  VERSION = "1.0.1"
+  VERSION = "1.2.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
@@ -42,6 +47,7 @@ module SemanticRelease
   def self.release
     Updaters::Changelog.update
     Updaters::VersionRb.update
+    Updaters::GemfileLock.update
     Updaters::GitTag.update
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: semantic_release
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - David Bull
 bindir: exe
 cert_chain: []
-date: 2025-02-02 00:00:00.000000000 Z
+date: 2025-02-06 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
@@ -22,10 +22,12 @@ files:
 - LICENSE.txt
 - README.md
 - 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
 - lib/semantic_release/updaters/changelog.rb
+- lib/semantic_release/updaters/gemfile_lock.rb
 - lib/semantic_release/updaters/git_tag.rb
 - lib/semantic_release/updaters/version_rb.rb
 - lib/semantic_release/version.rb