0.03
Low commit activity in last 3 years
No release in over a year
Create GitHub's compare view URLs for pull request from diff of Gemfile.lock
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

>= 1.3
>= 0
>= 0

Runtime

 Project Readme

Compare Linker

Travis Status License Gem

Description

Create GitHub's compare view URLs for pull request from diff of Gemfile.lock (and post comment to pull request).

screen shot 2016-10-09 at 7 53 23 pm

GitHub Compare View rocks.But diff of Gemfile.lock sucks. So I made Compare Linker.

Installation

Add this line to your application's Gemfile:

gem 'compare_linker'

And then execute:

$ bundle

Or install it yourself as:

$ gem install compare_linker

Usage

require 'compare_linker'

ENV['OCTOKIT_ACCESS_TOKEN'] = 'xxx'

compare_linker = CompareLinker.new('masutaka/compare_linker', '17')
compare_linker.formatter = CompareLinker::Formatter::Markdown.new
comment = compare_linker.make_compare_links.to_a.join("\n")
compare_linker.add_comment('masutaka/compare_linker', '17', comment)

GitHub Enterprise

In addition to OCTOKIT_ACCESS_TOKEN, set the following environment variables.

ENV['ENTERPRISE_OCTOKIT_ACCESS_TOKEN'] = 'xxx'
ENV['ENTERPRISE_OCTOKIT_API_ENDPOINT'] = 'https://www.example.com/api/v3'

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/masutaka/compare_linker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.