发布流程

这是关于如何发布的维护者须知。所有版本控制都遵循语义化版本 2.0.0。这意味着旧版本将会有错误修复的反向移植。

  1. 检查主分支上的测试套件是否通过。

  2. 回滚任何看起来不奏效的更改,并检查里程碑,看拉取请求是否已相应合并。

  3. 检查针对主分支的Wheel 构建是否按预期工作。

  4. 将仓库克隆到本地。

  5. 相应地在manimpango/_version中更新版本号。

  6. Release v<版本号> 提交所做的更改。

  7. 在本地创建标签,使用

git tag -s v<version-number>

注意

此处,-s 用于使用 gpg 签名标签,以便用户以后可以验证它,不应该在没有签名的情况下创建标签,因为 Github 会显示为未验证。

重要

消息应包含发布的更新日志。有一个 github actions 会创建一个包含更新日志的草稿发布。您可以编辑它们并将其复制到您创建的标签中。

  1. 将标签推送到远程。

  2. 前往Github,并使用相同的推送标签起草新的发布。您可以复制创建标签时复制的相同更新日志。

重要

您应该实际“起草新的发布”,而不是仅仅发布之前由 Github Action 创建的草稿发布。这很重要,以便触发 wheels 构建工作流。

  1. 检查 CI 是否将 wheels 和 .tar.gz 文件上传到 PyPi。

  2. 最后,测试已上传到PyPi.tar.gz 文件,并在新的虚拟环境中安装它。