DEVELOP.rst

Developer Guide

Tests

First, download CrateDB:

$ bundle exec ruby spec/bootstrap.rb

Install development dependencies:

$ bundle install

Then, run tests:

$ bundle exec rspec

Run linter:

$ bundle exec rubocop

Update linter violations file:

$ bundle exec rubocop --auto-gen-config

Preparing a Release

To create a new release, you must:

• Update CrateRuby.version in lib/crate_ruby/version.rb
• Add a section for the new version in the CHANGES.rst file
• Commit your changes with a message like "prepare release x.y.z"
• Push to origin/main
• Create a tag by running ./devtools/create_tag.sh

RubyGems Deployment

Update your package manager:

$ gem update --system

Build the new gem:

$ gem build crate_ruby.gemspec

Publish the new gem:

$ gem push crate_ruby-<VERSION>.gem

Here, <VERSION> is the version you are releasing.