GeneratorsRuby

Publishing to RubyGems

Publish your public-facing Fern Ruby SDK to the RubyGems registry. After following the steps on this page, you’ll have a versioned package published on RubyGems.

This page assumes that you have:

Configure generators.yml

1

Configure output location

Next, change the output location in generators.yml from local-file-system (the default) to pypi to indicate that Fern should publish your package directly to the PyPI registry:

1groups: 
2  ruby-sdk:
3    generators:
4      - name: fernapi/fern-ruby-sdk
5        version: 1.0.0-rc19
6        output:
7          location: rubygems
2

Add a unique package name

Your package name must be unique in the RubyGems repository, otherwise publishing your SDK to RubyGems will fail. Update your package name if you haven’t done so already:

1groups: 
2  ruby-sdk:
3    generators:
4      - name: fernapi/fern-ruby-sdk
5        version: 1.0.0-rc19
6        output:
7          location: rubygems
8          package-name: your-package-name
3

Configure clientClassName

The clientClassName option controls the name of the generated client. This is the name customers use to import your SDK (import { your-client-name } from 'your-package-name';).

1groups: 
2  ruby-sdk:
3    generators:
4      - name: fernapi/fern-ruby-sdk
5        version: 1.0.0-rc19
6        output:
7          location: rubygems
8          package-name: your-package-name
9        config:
10          clientClassName: YourClientName # must be PascalCase
4

Add repository location

Add the path to your GitHub repository to generators.yml:

1groups: 
2  ruby-sdk:
3    generators:
4      - name: fernapi/fern-ruby-sdk
5        version: 1.0.0-rc19
6        output:
7          location: rubygems
8          package-name: your-package-name
9        config:
10          clientClassName: YourClientName
11        github: 
12          repository: your-org/company-ruby

Set up RubyGems publishing authentication

1

Log into RubyGems

Log into RubyGems or create a new account.

3

Add New Key

When prompted to create a new API key:

  1. Name your key.
  2. Under Scopes, select Push rubygem
  3. Select All Gems under Gem Scope.
Replacing an existing gem

If you are overriding an existing gem, you can select the relevant package instead of entering All Gems.

  1. Set an expiration date.
  2. Click Create API Key.
Save your new key – it won’t be displayed after you leave the page.
Creating a New API Key
4

Configure RubyGems authentication token

Add api-key: ${RUBYGEMS_API_KEY} to generators.yml to tell Fern to use the RUBYGEMS_API_KEY environment variable for authentication when publishing to the PyPI registry.

ruby
1groups: 
2  ruby-sdk:
3    generators:
4      - name: fernapi/fern-ruby-sdk
5        version: 1.0.0-rc19
6        output:
7          location: rubygems
8          package-name: your-package-name
9          api-key: ${RUBYGEMS_API_KEY}
10        config:
11          clientClassName: YourClientName
12        github: 
13          repository: your-org/company-ruby

Release your SDK to RubyGems

At this point, you’re ready to generate a release for your SDK.

1

Set RubyGems environment variable

On your local machine, set the RUBYGEMS_API_KEY environment variable to the new API key you generated earlier:

$export RUBYGEMS_API_KEY=your-actual-rubygems-token
2

Generate your release

Regenerate your SDK and publish it on RubyGems:

$fern generate --group ruby-sdk --version <version>

Local machine output will verify that the release is pushed to your repository and tagged with the version you specified. Log back into RubyGems and navigate to Releases to see your new release.