https://github.com/packsaddle/ruby-compare_linker_wrapper

https://github.com/packsaddle/ruby-compare_linker_wrapper

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/packsaddle/ruby-compare_linker_wrapper
• Owner: packsaddle
• License: mit
• Created: 2015-03-12T12:23:47.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-01-17T13:04:58.000Z (almost 8 years ago)
• Last Synced: 2024-04-29T05:43:03.723Z (8 months ago)
• Language: Ruby
• Homepage: http://packsaddle.org
• Size: 32.2 KB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# CompareLinkerWrapper

[![Gem Version](http://img.shields.io/gem/v/compare_linker_wrapper.svg?style=flat)](http://badge.fury.io/rb/compare_linker_wrapper)

[![Build Status](http://img.shields.io/travis/packsaddle/ruby-compare_linker_wrapper/master.svg?style=flat)](https://travis-ci.org/packsaddle/ruby-compare_linker_wrapper)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'compare_linker_wrapper'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install compare_linker_wrapper

## Usage

```text

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

```text

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](https://rubygems.org).

## Contributing

1. Fork it ( https://github.com/packsaddle/ruby-compare_linker_wrapper/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request