Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/build-gems.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: Build Gems
on:
pull_request:
push:
branches:
- main
Expand Down
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@

![Ruby 3.1 | 3.2 | 3.3](https://img.shields.io/badge/ruby-3.1%20%7C%203.2%20%7C%203.3-blue.svg?style=for-the-badge)
[![MIT](https://img.shields.io/github/license/temporalio/sdk-ruby.svg?style=for-the-badge)](LICENSE)
<!-- TODO: [![Gem](https://img.shields.io/gem/v/temporalio?style=for-the-badge)](https://rubygems.org/gems/temporalio) -->
[![Gem](https://img.shields.io/gem/v/temporalio?style=for-the-badge)](https://rubygems.org/gems/temporalio)

[Temporal](https://temporal.io/) is a distributed, scalable, durable, and highly available orchestration engine used to
execute asynchronous, long-running business logic in a scalable and resilient way.

**Temporal Ruby SDK** is the framework for authoring workflows and activities using the Ruby programming language.

Also see:

* [Ruby Samples](https://github.com/temporalio/samples-ruby)
* [API Documentation](https://rubydoc.info/gems/temporalio)

⚠️ UNDER ACTIVE DEVELOPMENT

This SDK is under active development and has not released a stable version yet. APIs may change in incompatible ways
Expand Down Expand Up @@ -59,25 +64,23 @@ Notably missing from this SDK:

### Installation

Install the gem to the desired version as mentioned at https://rubygems.org/gems/temporalio. Since the SDK is still in
pre-release, the version should be specified explicitly. So either in a Gemfile like:
Can require in a Gemfile like:

```
gem 'temporalio', '<version>'
gem 'temporalio'
```

Or via `gem install` like:

```
gem install temporalio -v '<version>'
gem install temporalio
```

**NOTE**: Due to [an issue](https://github.com/temporalio/sdk-ruby/issues/162), fibers (and `async` gem) are only
supported on Ruby versions 3.3 and newer.

**NOTE**: MinGW-based Windows is not currently supported natively, but is via WSL. Prebuilt gems for Linux MUSL are also
not currently present. We also do not publish a gem for building from source at this time. See the
[Platform Support](#platform-support) section later for more information.
**NOTE**: MinGW-based Windows, Linux MUSL, and pure source based gems are not currently published. See the
[Platform Support](#platform-support) section for more information.

### Implementing an Activity

Expand Down
2 changes: 1 addition & 1 deletion temporalio/lib/temporalio/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module Temporalio
VERSION = '0.2.0-alpha1'
VERSION = '0.2.0'
end
2 changes: 1 addition & 1 deletion temporalio/temporalio.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
spec.metadata['homepage_uri'] = spec.homepage
spec.metadata['source_code_uri'] = 'https://github.com/temporalio/sdk-ruby'

spec.files = Dir['lib/**/*.rb', 'LICENSE', 'README.md', 'Cargo.*']
spec.files = Dir['lib/**/*.rb', 'LICENSE', 'README.md', 'Cargo.*', 'temporalio.gemspec']

spec.bindir = 'exe'
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
Expand Down
Loading