CompareLinkerWrapper

Installation

Add this line to your application's Gemfile:

gem 'compare_linker_wrapper'

And then execute:

$ bundle

Or install it yourself as:

$ gem install compare_linker_wrapper

Usage

compare-linker-wrapper 'example/Gemfile.lock' \
  --base origin/master \
  --formatter CompareLinker::Formatter::Markdown

* [octokit](https://github.com/octokit/octokit.rb): 3.8.0 => 3.8.1

compare-linker-wrapper 'example/Gemfile.lock' \
  --base origin/master \
  --formatter CompareLinker::Formatter::Text

octokit: https://github.com/octokit/octokit.rb 3.8.0 => 3.8.1

Useful Usage on CI

git diff --name-only origin/master \
 | grep ".*[gG]emfile.lock$" || RETURN_CODE=$?

case "$RETURN_CODE" in
 "" ) echo "found" ;;
 "1" )
   echo "not found"
   exit 0 ;;
 * )
   echo "Error"
   exit $RETURN_CODE ;;
esac

git diff --name-only origin/master \
 | grep ".*[gG]emfile.lock$" \
 | xargs compare-linker-wrapper --base origin/master \
    --formatter CompareLinker::Formatter::Markdown \
 | text-to-checkstyle \
 | saddler report \
    --require saddler/reporter/github \
    --reporter Saddler::Reporter::Github::PullRequestComment

Command

Commands:
  compare-linker-wrapper compare         # compare gemfile.lock
  compare-linker-wrapper help [COMMAND]  # Describe available commands or one specific command
  compare-linker-wrapper version         # Show the CompareLinkerWrapper version

Usage:
  compare-linker-wrapper compare

Options:
  [--debug], [--no-debug]
  [--verbose], [--no-verbose]
  [--base=BASE]
                               # Default: origin/master
  [--head=HEAD]
                               # Default: HEAD
  [--file=one two three]
  [--formatter=FORMATTER]
                               # Default: CompareLinker::Formatter::Text

compare gemfile.lock

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment. Run bundle exec compare_linker_wrapper to use the code located 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, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Fork it ( https://github.com/packsaddle/ruby-compare_linker_wrapper/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request