参考Ruby

发布到 RubyGems

以 Markdown 格式查看

将您面向公众的 Fern Ruby SDK 发布到 RubyGems 注册表。按照本页面的步骤操作后，您将在 RubyGems 上发布一个带版本的包。

本页面假设您已经：

  • 初始化了 fern 文件夹，拥有 Ruby SDK 的 GitHub 仓库，并在 generators.yml 中配置了 Ruby 生成器组。请参阅生成 SDK (Ruby)。

配置 generators.yml

1

配置 output 位置

接下来，将 generators.yml 中的输出位置从 local-file-system（默认）更改为 pypi，以指示 Fern 应该将您的包直接发布到 PyPI 注册表：

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

添加唯一的包名

您的包名在 RubyGems 仓库中必须是唯一的，否则将您的 SDK 发布到 RubyGems 将会失败。如果您尚未更新包名，请现在更新：

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

配置 clientModuleName

clientModuleName 选项控制生成的客户端名称。这是客户使用导入您的 SDK 的名称（import { your-client-name } from 'your-package-name';）。

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

添加仓库位置

将您的 GitHub 仓库路径添加到 generators.yml：

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

设置 RubyGems 发布身份验证

1

登录 RubyGems

登录 RubyGems 或创建新账户。

2

导航到账户设置

  1. 点击您的头像
  2. 选择 Settings。
  3. 向下滚动并点击 API Keys。
3

添加新密钥

当提示创建新的 API 密钥时：

  1. 为您的密钥命名。
  2. 在 Scopes 下，选择 Push rubygem
  3. 在 Gem Scope 下选择 All Gems。
替换现有 gem

如果您要覆盖现有的 gem，您可以选择相关的包而不是输入 All Gems。

  1. 设置过期日期。
  2. 点击 Create API Key。
保存您的新密钥 - 离开页面后将不会再显示。
Creating a New API Key
4

配置 RubyGems 身份验证令牌

将 api-key: ${RUBYGEMS_API_KEY} 添加到 generators.yml，告诉 Fern 在发布到 PyPI 注册表时使用 RUBYGEMS_API_KEY 环境变量进行身份验证。

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

将您的 SDK 发布到 RubyGems

此时，您已准备好为您的 SDK 生成发布版本。

1

设置 RubyGems 环境变量

在您的本地机器上，将 RUBYGEMS_API_KEY 环境变量设置为您之前生成的新 API 密钥：

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

生成您的发布版本

重新生成您的 SDK 并将其发布到 RubyGems：

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

本地机器输出将验证发布版本已推送到您的仓库并使用您指定的版本进行了标记。重新登录 RubyGems 并导航到 Releases 查看您的新发布版本。