create_changelog 1.3.2 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0e465bd87a2712b3ba1e1cea4a4718532d4b14b
-  data.tar.gz: ff192efec820f0b35290636ca13ae65c2acf65c3
+  metadata.gz: 045510ceb2accdf99976fceb64343d4ad79a4b43
+  data.tar.gz: 8b2e636aaf4c457fa0760a2399c2a96adb191678
 SHA512:
-  metadata.gz: 943fe31a361515180fe73c3b3f2d1f90f81ccefc7d0fc9360390314191f6cd3f3055d124821fea346f6c38345765f10b12b64efaa76b3446a9ac0197291bfd22
-  data.tar.gz: e6776a95a60206705a18fcde1c87c5e96be9e5bf53e96f95530fe24f96060358b81be9ad3d99cc00c358c40b4c22bcb16b7a49f853fc8193344d651abad5068b
+  metadata.gz: 3144d854c54393d680f541a18f42b2c7d52c8b27e066b550df5860af59ae746eb43813da79a4e76cd071597adec3978cffc8b4dee87a3d249ebe53a928b1cc81
+  data.tar.gz: cc89f63ea1dabb8e8210791bef26ef9f5d358fd8636be981ea3fbd929337bfcd28d26eb07c311a4c5ba8fca8caa5416dd6807b6e5ead513e18b8f7847a3d60d8

data/{CHANGELOG.md → NEWS.md}

@@ -1,5 +1,22 @@
+Version 1.4.0 (2016-04-03)
+------------------------------------------------------------------------
+
+- CHANGED: Output uses second-level rather than first-level headings now.
+- FIX: Prevent Git error message due to local .gitconfig configuration.
+
+* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
+
+
+Version 1.3.4 (2015-10-05)
+------------------------------------------------------------------------
+
+- NEW: Create Ubuntu package (ppa:bovender/bovender)
+
+* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
+
+
 Version 1.3.2 (2015-06-24)
-========================================================================
+------------------------------------------------------------------------
 
 - FIX: Properly sort and identify latest tags (tags are sorted as version numbers).
 
@@ -7,7 +24,7 @@ Version 1.3.2 (2015-06-24)
 
 
 Version 1.3.1 (2015-06-24)
-========================================================================
+------------------------------------------------------------------------
 
 - CHANGED: Added author and license information to program banner.
 - FIX: Do not crash on --no-recent if there aren't indeed recent changes.
@@ -17,7 +34,7 @@ Version 1.3.1 (2015-06-24)
 
 
 Version 1.3.0 (2015-01-21)
-========================================================================
+------------------------------------------------------------------------
 
 Version 1.3.0 adds a test suite that enables quality control during
 development, and fixes a number of bugs that appeared during testing.
@@ -33,7 +50,7 @@ development, and fixes a number of bugs that appeared during testing.
 
 
 Version 1.2.0 (2015-01-18)
-========================================================================
+------------------------------------------------------------------------
 
 - FIX: Make "-r", "--recent" option actually work.
 - FIX: Prevent combining -n and -r switch irrespective of order.
@@ -43,7 +60,7 @@ Version 1.2.0 (2015-01-18)
 
 
 Version 1.1.0 (2015-01-18)
-========================================================================
+------------------------------------------------------------------------
 
 - CHANGED: Accept dashes in addition to asterisks in changelog lines.
 - NEW: Create gem.
@@ -52,7 +69,7 @@ Version 1.1.0 (2015-01-18)
 
 
 Version 1.0.0 (2015-01-18)
-========================================================================
+------------------------------------------------------------------------
 
 
 

data/README.md

@@ -1,13 +1,15 @@
 [![Gem Version](https://badge.fury.io/rb/create_changelog.svg)](http://badge.fury.io/rb/create_changelog)
 
-create_changelog
+create-changelog
 ================
 
+## Description
+
 Ruby program with command-line interface that creates a changelog from
-log lines in a git repository that can be read and understood by end
+log lines in a Git repository that can be read and understood by end
 users.
 
-There are several approaches to creating changelog files from git
+There are several approaches to creating changelog files from Git
 commits (e.g., [gitchangelog][], [gitlog-to-changelog][gl2cl] and many
 more). None of these quite fit my needs, so I decided to create my own
 tool.
@@ -29,14 +31,13 @@ The reason why I chose to have special changelog lines rather than
 commit subjects is that commits are rather technical, but I want to have
 a changelog that can be read by 'normal' end users.
 
-create_changelog assumes that each tag in the repository represents a
+create-changelog assumes that each tag in the repository represents a
 release version. The changelog for a version consists of the tag's name,
 the tag's annotation, and the unique combined, filtered changelog lines
 of the tag annotation and all commits since the previous tag.
 
 
-Usage
------
+## Usage
 
 ### Creating log entries
 
@@ -69,7 +70,7 @@ changelog entries.
 ### Generating the log
 
 To generate a complete change log, simply run the tool in the directory
-of the git repository, or indicate a working directory:
+of the Git repository, or indicate a working directory:
 
 	ccl -d /home/me/my/repository
 
@@ -78,7 +79,7 @@ process it using tools like [pandoc][] for example. Of course, it is
 also possible to incorporate the command in the content files for a
 static site generator such as [nanoc][].
 
-If you want to track your log in the git repository, you will not yet
+If you want to track your log in the Git repository, you will not yet
 have an annotated tag for the version you are preparing at the time when
 you generate the changelog. In this case, the tool will use "Unpublished
 changes" as the heading for the latest changes. To rather use the
@@ -110,8 +111,7 @@ annotation. For example, using the Vim text editor, issue:
 The tool will make sure that no changelog lines are duplicated.
 
 
-Changelog format
-----------------
+## Changelog format
 
 The changelog format resembles the [suggestions][kacl] made by Olivier
 Lacan, but it does not fully comply with Olivier's specification. I have
@@ -119,44 +119,41 @@ not yet have the time to implement automatic generation of subheadings.
 Maybe I'll add the feature in the future.
 
 
-To do
------
+## To do
 
 - Add automatic subheadings
 - Add ability to handle multi-line change log entries
 - Add to-do list feature
 
 
-Live example
-------------
+## Example
 
-<http://xltoolbox.sf.net/changelog-ng>
+<http://xltoolbox.net/changelog-ng>
 
 ... or of course [CHANGELOG.md][] in this repository.
 
 
-Code
-----
+## Code
 
 The code is documented in [Yard][] style. The `doc` subdirectory is
 git-ignored so you can safely generate the docs.
 
 
-License
--------
+## License
+
+Copyright 2015 Daniel Kraus <bovender@bovender.de>
 
-	Copyright 2015 Daniel Kraus
-	Licensed under the Apache License, Version 2.0 (the "License");
-	you may not use this file except in compliance with the License.
-	You may obtain a copy of the License at
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-		http://www.apache.org/licenses/LICENSE-2.0
+        http://www.apache.org/licenses/LICENSE-2.0
 
-	Unless required by applicable law or agreed to in writing, software
-	distributed under the License is distributed on an "AS IS" BASIS,
-	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-	See the License for the specific language governing permissions and
-	limitations under the License.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 [gitchangelog]: https://pypi.python.org/pypi/gitchangelog
 [gl2cl]: https://github.com/manuelbua/gitver/blob/master/gitlog-to-changelog

data/lib/changelog.rb

@@ -107,7 +107,7 @@ class Changelog
 		tag.heading = @recent_changes_heading unless tag.heading
 		if tag.heading and (tag.text or combined_changelog)
 			output << tag.heading + " (#{tag.date})\n"
-			output << "=" * 72 + "\n"
+			output << "-" * 72 + "\n"
 		end
 		output << tag.text.join("\n") if tag.text
 		output << "\n" if tag.heading or tag.text

data/lib/git.rb

@@ -106,7 +106,7 @@ class Git
 	#
 	def self.get_tag_annotation(tag)
 		test_tag tag
-		`git tag -l -n99 #{tag}`.rstrip
+		`git tag --sort refname -l -n99 #{tag}`.rstrip
 	end
 
 	# Retrieves the author date of a tag

data/lib/version.rb

@@ -1,3 +1,3 @@
 module CreateChangelog
-	VERSION = '1.3.2'
+	VERSION = '1.4.1'
 end

data/lib/version.rb~

@@ -1,3 +1,3 @@
 module CreateChangelog
-	VERSION = '1.3.1'
+	VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: create_changelog
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.1
 platform: ruby
 authors:
 - Daniel Kraus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2016-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem-man
@@ -68,61 +68,40 @@ dependencies:
         version: 0.8.7
 description: "\t\tRuby program with command-line interface that creates a changelog
   from log\n\t\tlines in a git repository that can be read and understood by end users.\n"
-email: krada@gmx.net
+email: bovender@bovender.de
 executables:
 - ccl
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
+- NEWS.md
 - README.md
 - bin/ccl
-- bin/ccl~
 - features/changelog_only_recent_changes.feature
-- features/changelog_only_recent_changes.feature~
 - features/changelog_without_recent_changes.feature
-- features/changelog_without_recent_changes.feature~
-- features/commandline.feature~
 - features/complete_changelog.feature
-- features/complete_changelog.feature~
-- features/create_changelog.feature~
 - features/decorate_output.feature
-- features/decorate_output.feature~
-- features/prepare_release.feature~
 - features/step_definitions/git_steps.rb
-- features/step_definitions/git_steps.rb~
 - features/step_definitions/stdout_steps.rb
-- features/step_definitions/stdout_steps.rb~
 - features/support/assertions.rb
-- features/support/assertions.rb~
 - features/support/env.rb
-- features/support/env.rb~
 - lib/array.rb
-- lib/array.rb~
 - lib/changelog.rb
-- lib/changelog.rb~
 - lib/changelog_filter.rb
-- lib/changelog_filter.rb~
 - lib/commit_changelog.rb
-- lib/commit_changelog.rb~
 - lib/git.rb
-- lib/git.rb~
 - lib/tag.rb
-- lib/tag.rb~
 - lib/tag_list.rb
-- lib/tag_list.rb~
 - lib/version.rb
 - lib/version.rb~
 - test/test_changelog_filter.rb
-- test/test_changelog_filter.rb~
 - test/test_tag_list.rb
-- test/test_tag_list.rb~
 homepage: https://github.com/bovender/create-changelog
 licenses:
 - Apache License version 2
 metadata: {}
 post_install_message: |
-  create_changelog version 1.3.2 has been installed.
+  create_changelog version 1.4.1 has been installed.
   For usage information, type ccl -h
 rdoc_options: []
 require_paths:
@@ -139,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Creates end-user-friendly changelog from git messages.

data/bin/ccl~

@@ -1,134 +0,0 @@
-#!/usr/bin/env ruby
-# Create-changelog
-# Copyright 2015 Daniel Kraus
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Filters the git log of the repository in the current directory
-# for unique lines that match the pattern
-#   * [KEYWORD]: [DESCRIPTION]
-# The filtered lines are sorted and written to standard out.
-
-require 'optparse'
-require_relative '../lib/changelog.rb'
-require_relative '../lib/git.rb'
-require_relative '../lib/version.rb'
-
-if !Git.is_installed?
-  abort("FATAL: Git is not installed or cannot be executed.")
-end
-
-class CreateChangelogCli
-
-  def initialize
-    @action = nil
-    @working_dir = Dir.pwd
-    @exclude_recent = false
-  end
-
-  # Sets the desired action and aborts if an action was previously set.
-  # This serves to exclude conflicting flags on the command line.
-  #
-  # @param [Symbol] action
-  #   Desired action
-  def set_action(action)
-    abort "FATAL: Cannot combine these flags: #{action} and #{@action}." if @action
-    @action = action
-  end
-
-  def get_options
-    OptionParser.new do |opts|
-      exe_name = File.basename($PROGRAM_NAME)
-      opts.banner = <<EOF
-create_changelog version #{CreateChangelog::VERSION} - <https://github.com/bovender/create-changelog>
-(c) Copyright 2015 Daniel Kraus - distriuted under Apache License Version 2.0
-Creates changelog from log entries in git log\n
-Usage: #{exe_name} [options] [current_version]
-EOF
-      opts.on("-r", "--recent",
-              "Include only most recent changes") do 
-        set_action :recent
-      end
-      opts.on("-n", "--no-recent",
-              "Exclude the most recent changes (from untagged commits)") do 
-        @exclude_recent = true
-      end
-      opts.on("-d WORKING_DIR", "--dir WORKING_DIR",
-             "Use alternate working directory") do |dir|
-        @working_dir = dir
-      end
-      opts.on("-v", "--version", "Print version information and exit.") do
-        set_action :version
-      end
-    end
-  end
-
-  # Changes to the repository directory and executes the block, but only
-  # if the directory does contain a Git repository and if the repository
-  # is not empty.
-  #
-  # @param [Block] &block
-  #   Code to execute in the repository directory.
-  #
-  def in_repository(&block)
-    abort "FATAL: Directory does not exist" unless Dir.exist?(@working_dir)
-    Dir.chdir(@working_dir) do
-      abort "FATAL: Not a Git repository." unless Git.is_git_repository?
-      yield unless Git.is_empty_repository?
-    end
-  end
-
-  # Generates a log of most recent changes only (since last tag)
-  #
-  def generate_recent
-    in_repository do
-      change_log = Changelog.new
-      output = change_log.generate_recent
-      puts output if output
-    end
-  end
-
-  # Generates a complete changelog
-  #
-  def generate_complete
-    in_repository do
-      change_log = Changelog.new
-      change_log.recent_changes_heading = ARGV[0] unless ARGV.empty?
-      output = change_log.generate(@exclude_recent) 
-      puts output.rstrip if output 
-    end
-  end
-
-  # Main method of the command line application
-  #
-  def main
-    get_options.parse!
-    @action = :complete if @action.nil?
-    if @exclude_recent && @action != :complete
-      abort "FATAL: --no-recent switch does not make sense here"
-    end
-    case @action
-    when :recent
-      generate_recent
-    when :complete
-      generate_complete
-    when :version
-      puts CreateChangelog::VERSION
-    else
-      abort "FATAL: Unknown action '#{@action}'"
-    end
-  end
-end
-
-CreateChangelogCli.new.main
-
-# vim: nospell