GemComet

The gem_comet is a command line tool which to update and release your gem. Install as following:

$ gem install 'gem_comet'

Initialize gem_comet as following:

$ gem_comet init

Then, edit the created file: .gem_comet.yml as following.

version: 1

release:
  base_branch: master
  release_branch: release
  version_file_path: { Path of the version file. e.g. lib/gem_comet/version.rb }

Supported versions

• Ruby 2.7, 3.0

Usage

Display changelogs

Displays changelogs from last release to HEAD commit.

$ gem_comet changelog

Release

Creates update PR and release PR.

$ gem_comet release { The version number you want to release. e.g. "1.2.3" }

Then, you should check pull requests on your GitHub repository page. You will see two pull requests: "Update v1.2.3" and "Release v1.2.3". First, you should check "Update v1.2.3" and merge. Next, you should check "Release v1.2.3" and merge. The "Release v1.2.3" destination is the release branch. You should set up CI that to deploy the gem automatically.

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/[USERNAME]/gem_comet. 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.

Code of Conduct

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