Octy

Generate GitHub repository changelog.

Installation

Add this line to your application's Gemfile:

gem 'octy'

And then execute:

$ bundle

Or install it yourself as:

$ gem install octy

Usage

Set GitHub access token.

$ export GITHUB_ACCESS_TOKEN=xxx

Exec one liner.

$ octy changelog --repo ${user/repo} --from {branch/tag} --to {branch/tag}

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment. Run bundle exec octy to use the gem 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, 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/Kakakakakku/octy.

License

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