发布新版本

这里有一些关于何时以及如何发布新版本的指南。首先，正如“持续集成”文档中所暗示的，我们希望遵循一个相当紧密的发布计划，称为“持续部署”。对我们而言，这意味着新版本应该大约每周发布一次。

至于如何命名发布的版本，我们尝试遵循语义版本控制。更多详情请参见 semver.org。对于 SpeechBrain 而言，这可能意味着以下一些示例

• 对 Brain 类或其他核心元素的更改通常需要主要版本升级（例如 1.5.3 -> 2.0.0）

• 新增类或功能需要次要版本升级。大多数每周更新都应属于此类。

• 补丁版本升级只应针对错误修复。

应执行最终预发布测试！ 其中一些检查并非由 CI 运行。

发布新版本时，需要执行一些由用户发起的操作。

1. 在 develop 分支上，更新 speechbrain/version.txt 文件为新版本：X.Y.Z

2. 将 develop 分支合并到 main 分支：git checkout main git merge develop

3. 将 main 分支推送到 github：git push

4. 用新版本标记 main 分支：git tag vX.Y.Z

5. 将新标签推送到 github：git push –tags

这将启动一个自动操作，创建一个包含发布说明的草稿发布。审查说明，确保它们有意义，并删除不重要的提交。然后您可以发布该版本，使其公开。发布新版本会启动一系列自动化工具，如下所示

• checkout main 分支并用于构建 Python 包。

• 构建好的包被上传到 PyPI 并在那里发布。

• Read the Docs 使用 Webhooks 在新版本发布时收到通知。然后 Read the Docs 会构建文档并发布新版本。

相关账户的维护者

• Mirco Ravanelli 维护 GitHub 和 PyPI 账户

• Titouan Parcollet 维护网站 speechbrain.github.io 以及 Read the Docs 账户