xarray项目发布流程详解：从准备到公告的全方位指南

xarray项目发布流程详解：从准备到公告的全方位指南

xarray N-D labeled arrays and datasets in Python 项目地址: https://gitcode.com/gh_mirrors/xa/xarray

作为Python生态中重要的多维数组处理工具，xarray的版本发布需要遵循严谨的流程。本文将详细介绍xarray项目的完整发布流程，帮助开发者理解如何规范地进行版本发布。

发布前准备

在开始发布流程前，需要确保本地开发环境配置正确：

1. 确认远程仓库配置：确保upstream指向主代码库
2. 同步主分支：执行以下命令确保本地main分支与上游同步

   git switch main
   git pull upstream main
   

发布流程详解

第一步：贡献者名单生成

使用项目提供的脚本自动生成自上个版本以来的贡献者名单：

python ci/release_contributors.py

该脚本依赖gitpython和toolz/cytoolz包，会输出格式化的贡献者信息。

第二步：编写发布摘要

需要准备约50字的版本概要，重点描述：

• 主要新增功能
• 重大改进
• 核心变更

这份摘要将用于多个渠道的发布公告。

第三步：完善更新日志

仔细检查whats-new.rst文档，确保：

1. 所有变更已正确归类（新功能、破坏性变更、弃用项等）
2. 重要功能在顶部突出显示
3. 所有API引用都有正确的文档链接
4. 使用git diff核对变更是否归入正确版本

第四步：提交审核

将更新日志和发布摘要作为PR提交，获取团队反馈后再合并。

第五步：最终验证

合并后再次同步代码，并运行完整测试套件：

git pull upstream main
pytest

同时确认ReadTheDocs上的latest版本构建是否成功。

第六步：正式发布

1. 创建GitHub发布，填写版本号（带"v"前缀）和发布说明
2. 自动触发PyPI发布流程
3. 确认PyPI上显示正确的版本号

第七步：准备下个版本

在whats-new.rst中添加下个版本的占位章节，结构如下：

.. _whats-new.YYYY.MM.X+1:

vYYYY.MM.X+1 (unreleased)
-----------------------

New Features
~~~~~~~~~~~~

Breaking changes
~~~~~~~~~~~~~~~~

[其他标准部分...]

提交并推送这些变更后，主分支的发布工作就完成了。

后续工作

Pyodide支持更新

更新Pyodide中的xarray包信息：

1. 获取PyPI上的wheel文件信息
2. 修改Pyodide的meta.yaml文件
   • 更新版本号
   • 更新wheel文件链接
   • 更新SHA256哈希值

发布公告

根据版本重要性选择适当的渠道发布公告：

• 小版本：仅发送至xarray专用邮件列表
• 大版本：发送至更广泛的社区列表

公告标题通常以"ANN xarray"开头，内容基于之前准备的发布摘要。

版本号规范

自2022.03.0版本起，xarray采用日历化版本(CALVER)系统，格式为YYYY.MM.X：

• YYYY：4位年份（如2022）
• MM：2位月份（如03表示三月）
• X：发布序号（每月从0开始递增）

这种版本号方案能直观反映发布时间，同时保留足够的灵活性进行多次发布。

总结

xarray的发布流程体现了开源项目的严谨性，从代码准备、文档更新到多渠道公告，每个环节都至关重要。遵循这一流程能确保版本发布的规范性和信息的及时同步，为用户提供稳定可靠的新版本。

xarray N-D labeled arrays and datasets in Python 项目地址: https://gitcode.com/gh_mirrors/xa/xarray