bump 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83453453cffa0d63a765fc4fb7aa084d7a992da4
-  data.tar.gz: f4db814fff42565eee6927dc941b026c282939df
+  metadata.gz: 4cc77e3ae46a84602fc8c584624d77b69a44ef4e
+  data.tar.gz: a8a1fad7cc8f4f3db749556b81f1c51c168aaaa0
 SHA512:
-  metadata.gz: 9e74704154155f9ddb50c45b40a802b6a7a0088e07a7dd073fe1ee11e0580765f1a7add70ababfc247580230a700c3707d4ff75afea36f0bd8dac9c1c11792af
-  data.tar.gz: 9e892e2d1e59aa12abeab19e5fdff8b54594aa9c8912404d0fd503f64a0628a4601ae81d8fbe63406663e32c3bb6e70fe295234f773b017c0e4fe64e085e5c22
+  metadata.gz: e170caed9096057c8826562869cfd62b30b6cb25577b601242e17e3e603d620ddd5f43890cb7e47aa506719d2d198d13c18d581cfeaa21053c75757c3247d575
+  data.tar.gz: 48323ff4e45dd6d626781b7251402376c5821cb14f8bcb3ed5b9c8cf198f0af6893c69c3356ff26fdece50e6466e247069022fbcc79db85e71223951595d976a

data/README.md

@@ -1,9 +1,11 @@
 [![Build Status](https://travis-ci.org/gregorym/bump.svg)](https://travis-ci.org/gregorym/bump)
 [![Gem Version](https://badge.fury.io/rb/bump.svg)](http://badge.fury.io/rb/bump)
 
-# Introduction
+A gem to bump versions of gems and chef-cookbooks.
 
-Bump is a gem that will simplify the way you build gems and chef-cookbooks.
+ - bumps version major / minor / patch / pre
+ - bundles
+ - commits changes
 
 # Installation
 
@@ -11,35 +13,35 @@ Bump is a gem that will simplify the way you build gems and chef-cookbooks.
 
 # Usage
 
-Current version:
+### Show current version
 
     bump current
 
 > Current version: 0.1.2
 
-Show next patch version:
+### Bump (major, minor, patch, pre)
+
+    bump patch
+
+> Bump version 0.1.2 to 0.1.3
+
+### Show next version
 
     bump show-next patch
 
 > Next patch version: 0.1.3
 
-Version file path:
+### Show version file path
 
     bump file
 
 > Version file path: lib/foo/version.rb
 
-Bump (major, minor, patch, pre):
-
-    bump patch
-
-> Bump version 0.1.2 to 0.1.3
-
 ## Options
 
 ### `--no-commit`
 
-If you don't want to make a commit after bumping, add the `--no-commit` option.
+Do not commit after bumping.
 
     bump patch --no-commit
 
@@ -56,39 +58,54 @@ The `--tag-prefix` option can change the tag prefix:
 
 ### `--no-bundle`
 
-If you don't want to run the `bundle` command after bumping, add the `--no-bundle` option.
+Do not run `bundle` command after bumping.
 
     bump patch --no-bundle
 
 ### `--replace-in`
 
-If you want to bump the version in additional files
+Bump the version in additional files.
 
     bump patch --reaplace-in Readme.md
 
 ### `--commit-message [MSG], -m [MSG]`
 
-If you want to append additional information to the commit message, pass it in using the `--commit-message [MSG]` or `-m [MSG]` option.
+Append additional information to the commit message.
 
-    bump patch --commit-message [no-ci]
+    bump patch --commit-message "Something extra"
 
 or
 
-    bump patch -m [no-cli]
+    bump patch -m "Something extra"
+
+### `--changelog`
+
+Update `CHANGELOG.md` when bumping.
+This requires a heading (starting with `##`) that includes the previous version and a heading above that, for example:
+
+```markdown
+### Next
+- Added bar
 
-### Rake
+### v0.0.0 - 2019-12-24
+- Added foo
+```
+
+## Rake
 
 ```ruby
 # Rakefile
 require "bump/tasks"
 
 #
-# if you want to always tag the version, add:
-# Bump.tag_by_default = true
+# do not always tag the version
+# Bump.tag_by_default = false
 #
-# if you want to bump the version in additional files, add:
+# bump the version in additional files
 # Bump.replace_in_default = ["Readme.md"]
-
+#
+# Maintain changelog:
+# Bump.changelog = true
 ```
 
     rake bump:current                           # display current version
@@ -107,7 +124,7 @@ require "bump/tasks"
     rake bump:patch COMMIT=false TAG=false      # don't commit, don't tag
     rake bump:minor BUNDLE=false                # don't run `bundle`
 
-### Ruby
+## Ruby
 
 ```ruby
 require "bump"

data/bin/bump

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'optparse'
 require 'shellwords'
 
@@ -25,6 +27,7 @@ OptionParser.new do |opts|
   opts.on("--tag", "Create git tag from version (only if commit is true).") { options[:tag] = true }
   opts.on("--tag-prefix TAG_PREFIX", "Prefix the tag with this string, ex. 'v'") { |tag_prefix| options[:tag_prefix] = tag_prefix }
   opts.on("--replace-in FILE", String, "Replace old version with the new version additionally in this file") { |f| (options[:replace_in] ||= []) << f }
+  opts.on("--changelog", "Update CHANGELOG.md") { options[:changelog] = true }
   opts.on("-h", "--help", "Show this.") { puts opts; exit }
 end.parse!
 

data/lib/bump.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bump
   class InvalidIncrementError < StandardError; end
   class InvalidOptionError < StandardError; end
@@ -8,7 +10,7 @@ module Bump
   class RakeArgumentsDeprecatedError < StandardError; end
 
   class <<self
-    attr_accessor :tag_by_default, :replace_in_default
+    attr_accessor :tag_by_default, :replace_in_default, :changelog
   end
 
   class Bump
@@ -23,6 +25,7 @@ module Bump
           tag: ::Bump.tag_by_default,
           tag_prefix: 'v',
           commit: true,
+          changelog: ::Bump.changelog || false, # TODO: default to true with opt-out once it gets more stable
           bundle: File.exist?("Gemfile"),
           replace_in: ::Bump.replace_in_default || []
         }
@@ -134,6 +137,17 @@ module Bump
           end
         end
 
+        # changelog if needed
+        if options[:changelog]
+          log = Dir["CHANGELOG.md"].first
+          return ["Did not find CHANGELOG.md", 1] unless log
+
+          error = bump_changelog(log, next_version)
+          return [error, 1] if error
+
+          git_add log if options[:commit]
+        end
+
         # commit staged changes
         commit next_version, options if options[:commit]
 
@@ -160,6 +174,24 @@ module Bump
         bump(file, current, next_version, options)
       end
 
+      def bump_changelog(file, current)
+        parts = File.read(file).split(/(^##+.*)/) # headlines and their content
+        prev_index = parts.index { |p| p =~ /(^##+.*(\d+\.\d+\.\d+(\.[a-z]+)?).*)/ } # position of previous version
+        return "Unable to find previous version" unless prev_index
+
+        # reuse the same style by just swapping the numbers
+        new_heading = "\n" + parts[prev_index].sub($2, current)
+
+        # add current date if previous heading used that
+        new_heading.sub!(/\d\d\d\d-\d\d-\d\d/, Time.now.strftime('%Y-%m-%d'))
+
+        # put our new heading underneath the "Next" heading, which should be above the last version
+        parts.insert prev_index - 1, new_heading
+
+        File.write file, parts.join("")
+        nil
+      end
+
       def commit_message(version, options)
         tag = "#{options[:tag_prefix]}#{version}"
         options[:commit_message] ? "#{tag} #{options[:commit_message]}" : tag

data/lib/bump/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bump"
 
 namespace :bump do
@@ -18,8 +20,8 @@ namespace :bump do
       desc "Bump #{bump} part of gem version"
     end
 
-    task bump, :tag do |_task, args|
-      if args.tag
+    task bump, :no_args do |_task, args|
+      if args.no_args
         raise(
           RakeArgumentsDeprecatedError,
           "rake arguments are deprecated, use TAG=false to disable tagging"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bump
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Gregory Marcilhacy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2020-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="