GemChangelogDiff

CI Gem Version Gem Downloads Ruby Codecov

CLI that shows you the changelog diff for each gem before you bundle update, pulled from GitHub releases.

Table of Contents

Installation

Install the gem by executing:

gem install gem_changelog_diff

Or add it to your Gemfile:

bundle add gem_changelog_diff

Back to top

Usage

gem_changelog_diff

Run from a project directory with a Gemfile.lock. The tool detects outdated gems via bundle outdated, looks up their GitHub repositories, fetches release notes, and displays a formatted changelog diff.

gem_changelog_diff version    # Print version
gem_changelog_diff --version  # Same as above

GitHub Authentication

To avoid the 60 requests/hour unauthenticated rate limit, provide a GitHub personal access token:

gem_changelog_diff --token ghp_your_token
# or
export GITHUB_TOKEN=ghp_your_token
gem_changelog_diff

Output Control

gem_changelog_diff --verbose   # Show detailed status messages
gem_changelog_diff --quiet     # Suppress warnings
gem_changelog_diff --no-color  # Disable colored output

The tool also respects the $NO_COLOR environment variable.

Back to top

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.

Back to top

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/eclectic-coding/gem_changelog_diff.

Back to top

License

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