发布流程规范

版本命名

遵循语义化版本(SemVer):vMAJOR.MINOR.PATCH

  • MAJOR:不兼容的 API 变更
  • MINOR:向后兼容的功能新增
  • PATCH:向后兼容的 bug 修复

发布流程

1. 版本准备

# 确认所有待发布特性已合并到 master
git checkout master
git pull upstream master

# 确认版本号
# 版本号定义在 setup.py 或 __init__.py 中

2. 生成 Release Notes

# 分析自上一个 tag 到 HEAD 的变更
git log vPREV_TAG..HEAD --oneline
git diff vPREV_TAG..HEAD --stat

Release Notes 需包含:

  • 全量特性列表(首个正式版本需列出所有已实现特性)

  • 增量变更(标注上一个版本到当前版本的变更)

  • 贡献者名单

  • 已合并 PR 列表

  • 已知限制

  • 升级指南

3. 文档更新

每个版本发布前需同步更新:

文档类型 更新内容
README.md / README.en.md 特性 checkbox 更新、新特性章节
docs/guide/ 新增特性使用指南、更新已有指南
docs/api/ 新增接口说明、更新已有接口参数
docs/faq.md 新增常见问题
Release Notes 生成版本变更记录

4. 打 Tag

git tag -a vX.Y.Z -m "HyperParallel vX.Y.Z release"
git push upstream vX.Y.Z

5. 构建 Wheel

# 外部构建工程先选择 CANN 环境;统一入口完成依赖准备、native 编译和 wheel 打包
source /usr/local/Ascend/cann/set_env.sh
bash build.sh --multicore on --strict on --jobs 24

# 每个 Python ABI/host 架构一个 wheel,例如:
# hyper_parallel-0.1.0-cp310-cp310-linux_aarch64.whl

严格模式下,任一启用组件失败都会终止,本次不生成 wheel。开发场景使用默认 --strict off 时,optional native 组件失败会记录 warning 并继续组包;此时 wheel 生成不代表所有 optional 能力可用。正式发布由版本 指定的 glibc 基线构建、全量用例和人工评审共同决定。native 制品要求 CANN >= 9.1.0。

6. 发布后验证

逐组件执行其声明的制品、导入和 ST 验证。需要激活 SDK/制品环境的组件必须先激活再启动测试。

版本历史

版本 日期 说明
v0.2.0 — 上一个发布版本
v1.0.0 2026-06-30 首个正式版本,全量特性覆盖