yhirano55 / lock_diff

This gem detects changes to your package manager (e.g. Gemfile) and generates a Markdown-formatted diff

LockDiff

This gem detects changes to your package manager (e.g. Gemfile) and generates a Markdown-formatted diff including:

• links to the corresponding package's change logs
• Github ...-delineated diff links for the relevant changes

It also optionally posts the diff as a comment to the pull request responsible for the package update.

Like this.

vividmuimui/lock_diff_sample#9 (comment)

Strategies

• Gemfile.lock(Ruby/Bundler)

Installation

Add this line to your application's Gemfile:

gem 'lock_diff'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lock_diff

Usage

lock_diff requires you to provide a GITHUB_ACCESS_TOKEN as an environment variable.

Command line

$ lock_diff
Usage: lock_diff [options]
Require flags
    -r, --repository=REPOSITORY      Like as "user/repository"
    -n, --number=PULL_REQUEST_NUMBER

Optional flags
        --post-comment=true or false Print result to stdout when false. (default is false)
    -v, --verbose                    Run verbosely
        --version                    Show version

For example, to comment on vividmuimui/lock_diff_sample#9 (comment), run this command:

$ lock_diff -r "vividmuimui/lock_diff_sample" -n 9 --post-comment=false

Ruby

require 'lock_diff'
LockDiff.run(repository: "vividmuimui/lock_diff_sample", number: 9, post_comment: false)

For Tachikoma pull request

When used in conjunction with tachikoma, use the lock_diff_for_tachikoma command instead of lock_diff. lock_diff_for_tachikoma automatically detects and comments on the most recent tachikoma pull request.

Command line

$ lock_diff_for_tachikoma
Usage: lock_diff_for_tachikoma [options]
Require flags
    -r, --repository=REPOSITORY      Like as "user/repository"

Optional flags
        --post-comment=true or false Print result to stdout when false. (default is false)
    -v, --verbose                    Run verbosely
        --version                    Show version

$ lock_diff_for_tachikoma -r "vividmuimui/lock_diff_sample" --post-comment=false

Ruby

require 'lock_diff'
LockDiff.lock_diff_for_tachikoma(repository: "vividmuimui/lock_diff_sample", post_comment: false)

Development

TODO:

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lock_diff. 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.

Original

Most source code in this pepository is by https://github.com/kyanny/compare_linker .

Copyright (c) 2014 Kensuke Nagae

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.

Code of Conduct

Everyone interacting in the LockDiff project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.