Fern Autorelease

以 Markdown 格式查看
抢先体验

Fern Autorelease 目前处于抢先体验阶段。联系我们以开始使用。

Fern Autorelease 端到端自动化 SDK 发布。当您的 API 规范发生变更时,Autorelease 会重新生成 SDK,确定版本升级,并发布到包注册表。

工作原理

当 API 规范的变更被提交时,Autorelease 会:

  1. 为所有配置的语言重新生成 SDK
  2. 分析 API 差异并确定适当的语义版本升级
  3. 提交到仓库,标记发布,并发布包
  4. 自动更新变更日志

如果发布失败,Autorelease 会暂停并通过 Slack(如果已配置)或 Fern Dashboard 发送警报,您可以在其中审查和重试。

设置

要启用 Autorelease,请将 autorelease: true 添加到您的 generators.yml 并确保 Fern GitHub App 已安装在您的 SDK 仓库上。发布会在规范仓库的提交时自动触发,并显示为提交状态检查。无需更改您的 CI/CD 设置。

generators.yml
1autorelease: true
Autorelease commit status check

发布前审查发布

设置 mode: pull-request 以在发布前审查发布。Autorelease 会为您开启一个拉取请求以供审查,而不是直接发布。

generators.yml
1groups:
2 ts-sdk:
3 generators:
4 - name: fernapi/fern-typescript-sdk
5 ...
6 github:
7 repository: your-org/your-repo-name
8 mode: pull-request

禁用 autorelease

要在保持全局启用的情况下为特定生成器禁用 Autorelease,请在该生成器上设置 autorelease: false

generators.yml
1groups:
2 internal-sdk:
3 generators:
4 - name: fernapi/fern-python-sdk
5 version: 5.9.1
6 autorelease: false