milestoner 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c64c1d287d178bb4a94d22d147ab4cf0209596c
-  data.tar.gz: c7673a64ee8582a831713ea1d844dbed877059fe
+  metadata.gz: f12b4a3234f91869a03f18bc09985b9d02be75fb
+  data.tar.gz: a9569f873f4daf4f01e0c9702f8419e48dd0aeb9
 SHA512:
-  metadata.gz: 42b4ac251e73c7043c84cfabd70f6542f9b737227f49378cb6557e9328161be8d20465a4554cc9d63751dd3ff3e59998a88d1b37145b860fbbf0bfb1bb1c591a
-  data.tar.gz: 2c5a5e98610837905397ca9b69dd45b3a27657ff28871df493cc713b7dc8048793cf688e62549a3437adba0c9a95f462e019a95f8f2285e16b64ed0359d60f8f
+  metadata.gz: 8d42da86c3180c0f427c860fb3028c155bab76064f9f0a8c9d13059aac7eebfb653cf22d05dd357c4ba91b50dc2e2a85314cdd47afc66db069d578449ee05d0c
+  data.tar.gz: c653ec5f2de7f5f68c4e81f3fbf1f948a24f03c314b0ed851739f88f25169a105534cc91fadd5d8b1a41eb44fa1c89bfb8812a2cd4dc23d1e16db108a8ee655b

data/README.md

@@ -4,7 +4,7 @@
 [![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/milestoner.svg)](https://codeclimate.com/github/bkuhlmann/milestoner)
 [![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/milestoner/coverage.svg)](https://codeclimate.com/github/bkuhlmann/milestoner)
 [![Gemnasium Status](https://gemnasium.com/bkuhlmann/milestoner.svg)](https://gemnasium.com/bkuhlmann/milestoner)
-[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/milestoner.svg)](http://travis-ci.org/bkuhlmann/milestoner)
+[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/milestoner.svg)](https://travis-ci.org/bkuhlmann/milestoner)
 [![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
 
 A command line interface for releasing Git repository milestones.
@@ -19,6 +19,7 @@ A command line interface for releasing Git repository milestones.
 - [Usage](#usage)
   - [Command Line Interface (CLI)](#command-line-interface-cli)
   - [Customization](#customization)
+- [Security](#security)
 - [Tests](#tests)
 - [Versioning](#versioning)
 - [Code of Conduct](#code-of-conduct)
@@ -32,12 +33,17 @@ A command line interface for releasing Git repository milestones.
 # Features
 
 - Ensures [Semantic Versioning](http://semver.org) of Git repository tags:
-    - Format: `v<major>.<minor>.</maintenance>`.
+    - Format: `v<major>.<minor>.<maintenance>`.
     - Example: `v0.1.0`.
 - Ensures Git commits since last tag (or since initialization of repository if no tags exist) are included within each
   Git tag message.
-- Ensures Git commit messages are grouped by prefix, in order defined, for each Git tag message (prefixes can be
-  customized): "Fixed", "Added", "Updated", "Removed", "Refactored".
+- Ensures Git commit messages are grouped by prefix, in order defined, for each Git tag message. Prefix defaults (can be
+  customized):
+    - Fixed
+    - Added
+    - Updated
+    - Removed
+    - Refactored
 - Ensures Git commit merge messages are excluded within each Git tag message.
 - Ensures Git commit messages are alphabetically sorted within each Git tag message.
 - Ensures duplicate Git commit messages are removed (if any) within each Git tag message.
@@ -49,7 +55,7 @@ A command line interface for releasing Git repository milestones.
 # Requirements
 
 0. A UNIX-based system.
-0. [MRI 2.x.x](http://www.ruby-lang.org).
+0. [Ruby 2.3.x](https://www.ruby-lang.org).
 0. [GnuPG](https://www.gnupg.org).
 
 # Setup
@@ -88,9 +94,9 @@ For publish options, type: `milestoner help publish`
 
     -s, [--sign], [--no-sign]  # Sign tag with GPG key.
 
-When using Milestoner, the `--publish` command is intended to be the only command necessary for publishing a new
-release as it handles all of the steps necessary for tagging and pushing a new release. Should individual steps
-be needed, then the `--tag` and `--push` options are available.
+When using Milestoner, the `--publish` command is intended to be the only command necessary for publishing a new release
+as it handles all of the steps necessary for tagging and pushing a new milestone. Should individual steps be needed,
+then the `--tag` and `--push` options are available.
 
 ## Customization
 
@@ -127,7 +133,7 @@ Each `.milestonerrc` setting can be configured as follows:
 - `version`: By default it is left blank so you'll be prompted by the CLI. However, it can be nice to bump this version
   prior to each release and have the current version checked into source code at a per project level. The version, if
   set, will be used to tag the repository. If the version is a duplicate, an error will be thrown. When supplying a
-  version, use this format: `<major>.<minor>.</maintenance>`. Example: `0.1.0`.
+  version, use this format: `<major>.<minor>.<maintenance>`. Example: `0.1.0`.
 - `git_commit_prefixes`: Should the default prefixes not be desired, you can define Git commit prefixes that match your
   style. *NOTE: Prefix order is important with the first prefix defined taking precedence over the second and so forth.*
   Special characters are allowed for prefixes but should be enclosed in quotes if used. To disable prefix usage
@@ -136,6 +142,34 @@ Each `.milestonerrc` setting can be configured as follows:
   signing for enhanced security and include a signed signature as part of the Git tag. This is useful for public
   milestones where the author of a milestone can be verified to ensure milestone integrity/security.
 
+# Security
+
+To securely sign your Git tags, install and configure [GPG](https://www.gnupg.org):
+
+    brew install gpg
+    gpg --gen-key
+
+When creating your GPG key, choose these settings:
+
+- Key kind: RSA and RSA (default)
+- Key size: 4096
+- Key validity: 0
+- Real Name: `<your name>`
+- Email: `<your email>`
+- Passphrase: `<your passphrase>`
+
+To obtain your key, run the following and take the part after the forward slash:
+
+    gpg --list-keys | grep pub
+
+Add your key to your global Git configuration in the `[user]` section. Example:
+
+    [user]
+      signingkey = <your GPG key>
+
+Now, when publishing a new milestone (i.e. `milestoner --publish <version> --sign`), signing of your Git tag will happen
+automatically. You will be prompted for the GPG Passphrase each time but that is to be expected.
+
 # Tests
 
 To test, run:

data/bin/milestoner

@@ -1,4 +1,5 @@
 #!/usr/bin/ruby
+# frozen_string_literal: true
 
 require "milestoner"
 require "milestoner/cli"

data/lib/milestoner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "milestoner/aids/git"
 require "milestoner/errors/base"
 require "milestoner/errors/configuration"

data/lib/milestoner/aids/git.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Milestoner
   module Aids
     # Augments an object with Git support.

data/lib/milestoner/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 require "thor"
 require "thor/actions"

data/lib/milestoner/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Milestoner
   # Default configuration for gem with support for custom settings.
   class Configuration

data/lib/milestoner/errors/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Milestoner
   module Errors
     # The base class for all Milestoner related errors.

data/lib/milestoner/errors/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Milestoner
   module Errors
     # Raised for invalid gem configuration.

data/lib/milestoner/errors/duplicate_tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Milestoner
   module Errors
     # Raised for duplicate tags.

data/lib/milestoner/errors/git.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Milestoner
   module Errors
     # Raised for projects not initialized as Git repositories.

data/lib/milestoner/errors/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Milestoner
   module Errors
     # Raised for invalid version formats.

data/lib/milestoner/identity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Milestoner
   # Gem identity information.
   module Identity
@@ -10,7 +12,7 @@ module Milestoner
     end
 
     def self.version
-      "1.2.0"
+      "2.0.0"
     end
 
     def self.version_label

data/lib/milestoner/publisher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Milestoner
   # Handles the tagging and pushing of a milestone to a remote repository.
   class Publisher

data/lib/milestoner/pusher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Milestoner
   # Handles publishing of Git tags to remote repository.
   class Pusher

data/lib/milestoner/tagger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "open3"
 
 module Milestoner
@@ -73,11 +75,11 @@ module Milestoner
     end
 
     def raw_commits
+      log_command = "git log --oneline --no-merges --format='%s'"
       tag_command = "$(git describe --abbrev=0 --tags --always)..HEAD"
-      full_command = "git log --oneline --no-merges --format='%s' #{tag_command}"
-      full_command.gsub!(tag_command, "") unless tagged?
+      commits_command = tagged? ? "#{log_command} #{tag_command}" : log_command
 
-      `#{full_command}`.split("\n")
+      `#{commits_command}`.split("\n")
     end
 
     def build_commit_prefix_groups

data/lib/tasks/console.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+desc "Open IRB console for gem development environment"
+task :console do
+  require "irb"
+  require "milestoner"
+  ARGV.clear
+  IRB.start
+end

data/lib/tasks/rspec.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require "rspec/core/rake_task"
   RSpec::Core::RakeTask.new(:spec)

data/lib/tasks/rubocop.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require "rubocop/rake_task"
   RuboCop::RakeTask.new

metadata

@@ -1,36 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: milestoner
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMQ8wDQYDVQQDDAZicm9v
-  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
-  aW8wHhcNMTUwNzA1MTQ1MzExWhcNMTYwNzA0MTQ1MzExWjBBMQ8wDQYDVQQDDAZi
-  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
-  GRYCaW8wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCzhOVcvLGBCceM
-  PppVpJLUKsnskWzc1VqBXmv30feKNw+MOxMQaDsIP421qwqGO/2JHY60Kuobssk+
-  8/wqZkVFF/FFKxoQjuhlhc+VWLm8jWgXd4N1kwO2yytscQTzxc5qXarwA+36fqVH
-  RhBAHhjka+HdBI+6o3CXRHJoC47iav+QpR7u/wYl3gNq6MJO3MmTKqHegEDLjRN0
-  FJAr3bRAwq03ZtTuAVA2bdKLGThehe1RRRtJHJ/PHpmL2c203/GTXYtG6C8ILZIp
-  ZroTqQ8yglCJ+3hSOmodZqSAQ0Rj7GJgtuNH81qlSrHu5sTvoZjGmEqSIhvsSJ80
-  wKoPdZnFAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBSUnF478a5lB4xuOBiktJdMJv6JmDAfBgNVHREEGDAWgRRicm9va2VAYWxjaGVt
-  aXN0cy5pbzAfBgNVHRIEGDAWgRRicm9va2VAYWxjaGVtaXN0cy5pbzANBgkqhkiG
-  9w0BAQUFAAOCAQEAT7KtBXWsq1KA7NOSMeFEDeSvhrgdLwCG/37pIu0rjvx9iAW4
-  gncxV0MccqIUtaF+lekjlXkIO+rXAVjvdha23KtpFTW90dYXp4NLPnPlSdyvYzJy
-  FIAaWGvujOT8xEu4umd45q5aepE8li4bR071i5Z7F0trKNVYYrxjQFmH5SSKYRT/
-  fXtICtAh1de3z3SOSK58IMPwjuoApYBxiqlmx0Uhla7mrzCE5+NmLPit3hLH6JFK
-  aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
-  xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
-  -----END CERTIFICATE-----
-date: 2015-11-28 00:00:00.000000000 Z
+cert_chain: []
+date: 2016-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -74,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -324,6 +288,7 @@ files:
 - lib/milestoner/publisher.rb
 - lib/milestoner/pusher.rb
 - lib/milestoner/tagger.rb
+- lib/tasks/console.rake
 - lib/tasks/rspec.rake
 - lib/tasks/rubocop.rake
 homepage: https://github.com/bkuhlmann/milestoner
@@ -336,9 +301,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -346,7 +311,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A command line interface for releasing Git repository milestones.