release_tagger 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b61ec6e9b9428c4fed0e4b50ea7c9e3a38d4327
+  data.tar.gz: 33fb22c3503b91a8cbe7ca19038b382f15512a2d
+SHA512:
+  metadata.gz: d08b4af17c06ff0368e4eb05949ace93eabb2627e680518d535bde099445324d3bfa3652c12d187c1ae1d1fc9c23e0b9a5b91ace5ea3d524643449692d67f0a5
+  data.tar.gz: a9d3daf083b54d3ddc026862dbf9fa55a65ea486cbac81fba60f28975785bd273b7830aadff3c1b1942677a26cffd0573984f4f175f1297eef2cd3fbe364c9d5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.3

data/CODE_OF_CONDUCT.markdown

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in release_tagger.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lostmy.name Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,61 @@
+# ReleaseTagger
+
+A simple command-line tool to manage a git tag-based release workflow.
+It:
+
+1. Ensures the working directory is clean and up-to-date
+2. Ensures a non-master branch is not being released
+3. Bumps the requested version number (major, minor or patch)
+4. Creates a release commit noting changes since the last release
+5. Tags the release commit
+6. Pushes the whole lot to the origin repo
+
+That's all. Any other build steps are to be managed manually, or by CI
+watching for release tags in the origin repo.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'release_tagger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install release_tagger
+
+## Usage
+
+    $ do_release (major|minor|patch)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake rspec` to run the tests. You can also run `bin/console`
+for an interactive prompt that will allow you to experiment. Run `bundle
+exec release_tagger` to use the gem in this directory, ignoring other
+installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`.
+
+To release a new version, use the gem itself to apply the version tag,
+then manually:
+
+    $ gem build release_tagger.gemspec
+    $ gem push
+
+This will be handled by CI when this has tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/Lostmyname/release_tagger. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [Contributor
+Covenant](contributor-covenant.org) code of conduct.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "release_tagger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/do_release

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "release_tagger"

data/lib/release_tagger/version.rb

@@ -0,0 +1,5 @@
+module ReleaseTagger
+  VERSION = File.read(
+    File.join(File.dirname(__FILE__), "..", "..", "VERSION")
+  ).strip
+end

data/lib/release_tagger.rb

@@ -0,0 +1,175 @@
+require "release_tagger/version"
+require 'pathname'
+
+module ReleaseTagger
+
+  Version = Struct.new(:major, :minor, :patch) do
+    def bump(type)
+      raise ArgumentError,
+        "Could not bump #{type} version" unless respond_to?(type)
+
+      numbers =
+        case type
+        when "major" then [major + 1, 0,         0]
+        when "minor" then [major,     minor + 1, 0]
+        when "patch" then [major,     minor,     patch + 1]
+        end
+
+      self.class.new(*numbers)
+    end
+
+    def to_s
+      [major, minor, patch].join(".")
+    end
+  end
+
+  class << self
+
+    def color_terminal?
+      ENV["TERM"] =~ /color/
+    end
+
+    def green(string)
+      if color_terminal?
+        "\x1b[0;32m#{string}\x1b[0m"
+      else
+        string
+      end
+    end
+
+    def red(string)
+      if color_terminal?
+        "\x1b[0;31m#{string}\x1b[0m"
+      else
+        string
+      end
+    end
+
+    def log(message)
+      $stdout.puts(green(message))
+    end
+
+    def err(message)
+      $stderr.puts(red(message))
+    end
+
+    def usage
+      puts "Usage: #{File.basename($0)} (major|minor|patch)"
+    end
+
+    def valid_release_type?(type)
+      %w{ major minor patch }.include?(type)
+    end
+
+    def on_master_branch?
+      `git rev-parse --abbrev-ref HEAD`.strip == "master"
+    end
+
+    def behind_origin?
+      %x{git fetch origin >/dev/null 2>&1; git diff --stat HEAD...@{u}}.strip != ""
+    end
+
+    def dirty_working_tree?
+      %x{git status --porcelain 2>/dev/null | egrep "^(M| M)"}.strip != ""
+    end
+
+    def release_message(version)
+      "Release v#{version}"
+    end
+
+    def changelog(old_version)
+      commits = %x{git log --pretty="format:* %s" v#{old_version}..HEAD}
+      unless $?.success?
+        raise RuntimeError, "Error getting changelog!"
+      end
+      commits
+    end
+
+    def run!
+      if ARGV.length != 1
+        usage
+        exit 1
+      end
+
+      release_type = ARGV.first
+
+      if !valid_release_type?(release_type)
+        usage
+        exit 1
+      end
+
+      if !on_master_branch?
+        err "You must be on the master branch to make a release"
+        exit 1
+      end
+
+      if behind_origin?
+        err "You are behind the origin/master branch - please pull before releasing."
+        exit 1
+      end
+
+      if dirty_working_tree?
+        err "There are uncommitted changes in the working directory."
+        err "Please commit or stash all changes before making a release."
+        exit 1
+      end
+
+      version_file = Pathname.new(__FILE__).join("..", "..", "VERSION")
+
+      if !version_file.exist?
+        err "Could not find VERSION file - this must be present to make a release"
+        exit 1
+      end
+
+      old_version_string = version_file.read.strip
+      old_version_parts  = old_version_string.split(".").map(&:to_i)
+      old_version        = Version.new(*old_version_parts)
+      new_version        = old_version.bump(release_type)
+
+      $stderr.write "This will release version #{new_version}. Are you sure? [y/N]: "
+      unless STDIN.gets.strip == "y"
+        err "Exiting."
+        exit 1
+      end
+
+      if !version_file.writable?
+        err "Could not write to VERSION file - please check you have write permissions"
+        exit 1
+      end
+
+      log "Updating VERSION file to #{new_version}"
+      version_file.open("w") do |f|
+        f.write(new_version.to_s)
+      end
+
+      log "Creating release commit"
+      commits = changelog(old_version)
+      commit_output = %x{git add -u . && git commit -m "#{release_message(new_version)}\n\n#{commits}" 2>&1}
+      unless $?.success?
+        err "Error committing VERSION update:"
+        err commit_output
+        exit 1
+      end
+
+      log "Adding release tag"
+      tag_output = %x{git tag v#{new_version} 2>&1}
+      unless $?.success?
+        err "Error adding version tag v#{new_version}:"
+        err tag_output
+        exit 1
+      end
+
+      log "Pushing release to origin"
+      # Separate `push` and `push --tags` here, because only relatively recent
+      # versions of git push both refs and tags with the single command.
+      push_output = %x{git push 2>&1 && git push --tags 2>&1}
+      unless $?.success?
+        err "Error pushing release tag to origin:"
+        err push_output
+        exit 1
+      end
+    end
+  end
+end
+
+ReleaseTagger.run!

data/release_tagger.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'release_tagger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "release_tagger"
+  spec.version       = ReleaseTagger::VERSION
+  spec.authors       = ["Simon Coffey"]
+  spec.email         = ["dev@lostmy.name"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Helpers for managing a simple git tag-based release workflow}
+  spec.description   = %q{A set of helpers for tagging releases and logging changes between releases}
+  spec.homepage      = "https://github.com/Lostmyname/release_tagger"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.3", ">= 3.3.0"
+  spec.add_development_dependency "rubocop", "~> 0.32.1"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: release_tagger
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Simon Coffey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+description: A set of helpers for tagging releases and logging changes between releases
+email:
+- dev@lostmy.name
+executables:
+- do_release
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.markdown
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- exe/do_release
+- lib/release_tagger.rb
+- lib/release_tagger/version.rb
+- release_tagger.gemspec
+homepage: https://github.com/Lostmyname/release_tagger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Helpers for managing a simple git tag-based release workflow
+test_files: []