Temporal Ruby SDK

⚠️ UNDER ACTIVE DEVELOPMENT

The last tag before this refresh is v0.1.1. Please reference that tag for the previous code.

TODO: Usage documentation

Development

Build

Prerequisites:

• Ruby >= 3.1 (i.e. ruby and bundle on the PATH)
• Rust latest stable (i.e. cargo on the PATH)
• Protobuf Compiler (i.e. protoc on the PATH)
• This repository, cloned recursively
• Change to the temporalio/ directory

To build shared library for development use:

bundle exec rake compile:dev

To build and test release:

bundle exec rake

Testing

This project uses minitest. To test:

bundle exec rake test

Can add options via TESTOPTS. E.g. single test:

bundle exec rake test TESTOPTS="--name=test_start_workflows_async"

Code Formatting and Type Checking

This project uses rubocop:

bundle exec rake rubocop:autocorrect

This project uses steep. First may need the RBS collection:

bundle exec rake rbs:install_collection

Now can run steep:

bundle exec rake steep

Proto Generation

Run:

bundle exec rake proto:generate