anchorman 0.5.0

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright © 2013 infews
+
+MIT License
+
+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.md

@@ -0,0 +1,70 @@
+# Anchorman
+[![Build Status](https://travis-ci.org/infews/anchorman.png)](https://travis-ci.org/infews/anchorman)
+
+_When you need trusted news, you turn to an anchorman._
+
+Simply put, Anchorman scans your commit log and builds release notes for your project.
+
+These notes are build in [Markdown][md] and live in a `release_notes` directory off of your project root. When viewed locally they will be readable. When viewed on Github they will be rendered as nice HTML.
+
+There is also an option to generate HTML versions of these files using [Github Flavored Markdown][gfm] for posting/hosting elsewhere.
+
+If the repo is cloned from Github commit SHAs will be linked to Github's commits page.
+
+If a commit message includes syntax for manipulating a story at [Pivotal Tracker's][pt] via a post-commit hook, the story id will be linked to Tracker.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'anchorman'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install anchorman
+
+## Usage
+
+Anchorman is fairly simple-minded. It generates files with a little bit of formatting, but not much. The resulting files are meant as good starting points for more human-readable release notes.
+
+    $ anchorman notes
+
+Generates a `release_notes/release_notes.md` off of the root of your project. Has a simple header and will have a bullet list of commit information from your entire repo.
+
+    $ anchorman notes --from=<ref> --to=<ref>
+
+Builds notes only for commits between two git refs. If not supplied, `to` defaults to `HEAD`. Can be combined with other options.
+
+    $ anchorman notes --name=<filename>
+
+Writes out notes to `release_notes/<filename>.md`.Can be combined with other options.
+
+### coming soon
+
+    $ anchorman html
+
+Builds `release_notes/html` with html versions of all Markdown files in `release_notes`
+
+Samples can be found in this repository.     
+
+
+
+
+## Contributing
+
+1. Checkout the [backlog at Pivotal Tracker][backlog]
+1. Fork it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request
+
+
+[pt]: http://www.pivotaltracker.com
+[md]: http://daringfireball.net/projects/markdown/
+[gfm]: https://help.github.com/articles/github-flavored-markdown
+[backlog]: https://www.pivotaltracker.com/projects/776269

data/bin/anchorman

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'anchorman'
+
+Anchorman::CLI.start

data/lib/anchorman.rb

@@ -0,0 +1,7 @@
+require "thor"
+require "git"
+
+require "anchorman/repo"
+require "anchorman/commit_formatter"
+require "anchorman/version"
+require "anchorman/cli"

data/lib/anchorman/cli.rb

@@ -0,0 +1,47 @@
+module Anchorman
+  class CLI < Thor
+
+    include Thor::Actions
+
+    desc "notes", "Generates a draft release notes document"
+    method_options from: :string, to: :string, name: "release_notes"
+    def notes
+      git = open_repo
+
+      commits = if options[:from]
+                  git.log.between options[:from], options[:to]
+                else
+                  git.log
+                end
+
+      return unless commits.size
+
+      say "#{commits.size} commit(s) found - building notes", :green
+
+      empty_directory 'release_notes'
+
+      header = "# Release Notes\n\n## Summary\n\n## Changes\n\n"
+      formatter = CommitFormatter.new(Repo.new(git))
+      notes =  commits.collect {|c| formatter.format(c) }.join("\n\n")
+
+      create_file "release_notes/#{options[:name]}.md" do
+        header + notes
+      end
+
+    end
+
+    no_tasks do
+
+      def open_repo
+        git = Git.open('.')
+        git.log.size # this will raise if no repo or no commits
+        git
+      rescue ArgumentError
+        say 'No git repo found', :red
+      rescue Git::GitExecuteError
+        say 'No git log found', :red
+      end
+
+    end
+  end
+end

data/lib/anchorman/commit_formatter.rb

@@ -0,0 +1,23 @@
+module Anchorman
+  class CommitFormatter < Struct.new(:repo)
+
+    def format(commit)
+      note = "* SHA: #{repo.commit_url(commit.sha)}\n"
+      note << "    * #{format_message(commit.message)}\n"
+      note << "    * #{commit.author.name}, #{commit.author.email}\n"
+      note
+    end
+
+    private
+
+    def format_message(msg)
+      link_tracker_stories(msg)
+    end
+
+    def link_tracker_stories(msg)
+      msg.gsub(/\[(.*)#(\d+)\]/) do
+        "[#{$1}##{$2}](http://www.pivotaltracker.com/story/#{$2})"
+      end
+    end
+  end
+end

data/lib/anchorman/repo.rb

@@ -0,0 +1,27 @@
+module Anchorman
+  class Repo < Struct.new(:git_repo)
+
+    def remote
+      git_repo.remote
+    end
+
+    def is_github?
+      remote &&
+          remote.name == "origin" &&
+          remote.url &&
+          remote.url.match(/github\.com/)
+    end
+
+    def commit_url(sha)
+      return sha unless is_github?
+
+      "[#{sha}](#{github_url_for 'commit', sha})"
+    end
+
+    private
+
+    def github_url_for(*components)
+      [remote.url[0..-5], *components].join('/')
+    end
+  end
+end

data/lib/anchorman/version.rb

@@ -0,0 +1,3 @@
+module Anchorman
+  VERSION = "0.5.0"
+end

data/release_notes/release_notes.md

@@ -0,0 +1,17 @@
+# Anchorman Release Notes
+
+## Summary
+
+First Release. A real MVP.
+
+## v 0.5.0
+
+* First Release
+* Support for `anchorman notes --from=<ref> --to=<ref> --name=<output file>`
+* The commit history is a mess due to misuse of `git config` for the git repos under test
+* Adding [Travis](http://travis-ci.org) builds.
+    * SHA: [ca66e8240b7cf1a86412e3463bc54c6d96fb7a34](https://github.com/infews/anchorman/commit/ca66e8240b7cf1a86412e3463bc54c6d96fb7a34)
+    * Davis W. Frank, dwfrank+github@infe.ws
+* Building wrong Github URL to the commit [Fixes #45905835](http://www.pivotaltracker.com/story/45905835)
+    * SHA: [01946ca9bf3d0752ee48a0f3247d0f120bee6214](https://github.com/infews/anchorman/commit/01946ca9bf3d0752ee48a0f3247d0f120bee6214)
+    * Davis W. Frank, dwfrank+github@infe.ws

data/release_notes/sample.md

@@ -0,0 +1,9 @@
+# Release Notes
+
+## Summary
+
+## Changes
+
+* SHA: a8dbf3a2fd044e57655113801df1a20d932e4270
+  * This is another commit
+  * Ron, scotchyscotch@example.com

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: anchorman
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- infews
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extract release notes from your git log
+email:
+- dwfrank+github@infe.ws
+executables:
+- anchorman
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/anchorman
+- lib/anchorman/cli.rb
+- lib/anchorman/commit_formatter.rb
+- lib/anchorman/repo.rb
+- lib/anchorman/version.rb
+- lib/anchorman.rb
+- release_notes/release_notes.md
+- release_notes/sample.md
+- LICENSE.md
+- README.md
+homepage: http://github.com/infews/anchorman
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -963451566946939241
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -963451566946939241
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Executable that scans your git log for specific release tags and builds a
+  directory of nicely formatted set of Markdown files ready for detailed editing into
+  release notes.
+test_files: []