Please note that the bulk of this repo is in fact a submodule of the Ably Ruby REST & Realtime library. If you want to issue a PR, it is likely you should be looking in that repo to add features or make contributions.
The dependencies in ably-rest.gemspec must be manually kept in sync with those in lib/submodules/ably-ruby/ably.gemspec.
- Fork it
- When pulling to local, make sure to also pull submodules (git submodule init && git submodule update)
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Ensure you have added suitable tests and the test suite is passing(
bundle exec rspec) - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
- Create a branch for the release, named like
release/1.2.3(where1.2.3is the new version number) - Change dir to
cd lib/submodules/ably-rubyandgit fetch origin && git fetch --tags - Reset to the tagged version released in ably-ruby, e.g.
git reset v1.2.3 --hard - Ensure submodules of this submodule are up to date using
git submodule update - Change dir back to root /
ably-ruby-rest - Stage changes made at submodule file
git add lib/submodules/ably-ruby - Bring dependency versions in
ably-rest.gemspecin line withlib/submodules/ably-ruby/ably.gemspec - Commit the change
git commit -m "Version upgrade to v1.2.3"and push the changes. - Make a PR against
main. Once the PR is approved, merge it intomain - Add a tag to the new
mainhead commit and push to origin such asgit tag v1.2.3 && git push origin v1.2.3 - Visit https://github.com/ably/ably-ruby/tags and
Add release notesfor the release including links to the changelog entry. - Run
rake releaseto publish the gem to Rubygems
See the Ably Ruby release process notes.