Skip to content

构建与发布 ​

版本号 ​

项目使用 语义化版本:

  • 主版本号:不兼容的改动(如数据库或接口行为的破坏性变化)
  • 次版本号:向下兼容的新功能
  • 修订号:向下兼容的问题修复

版本号写在两处,必须一致:

  • 仓库根目录的 VERSION
  • app/__init__.py 的 __version__

文档站从 VERSION 读取版本号,显示在导航栏和页脚。

发布步骤 ​

  1. 更新 VERSION 和 app/__init__.py。
  2. 在 CHANGELOG.md 顶部添加新版本的条目(文档站的「更新日志」直接引用这个文件)。
  3. 同步更新受影响的文档页面,以及 skills/assemblyai-hub/ 中的版本号和接口说明。
  4. 提交并打标签:
bash
git commit -am "Release v3.5.0"
git tag -a v3.5.0 -m "v3.5.0"
git push origin main --tags
  1. 在 GitHub 上基于该标签创建 Release,正文使用 CHANGELOG 中对应的条目。

镜像构建 ​

.github/workflows/docker.yml 在以下情况构建 linux/amd64 + linux/arm64 镜像并推送到 GHCR:

触发生成的标签
推送到 mainlatest、sha-<短提交号>
推送 v* 标签X.Y.Z、X.Y、sha-<短提交号>
手动触发同上,按当前引用

文档站 ​

文档站位于 docs-site/,使用 VitePress:

bash
cd docs-site
npm install
npm run dev      # 本地预览
npm run build    # 输出到 docs-site/.vitepress/dist

构建产物是纯静态文件,可部署到任意静态托管(Cloudflare Workers / Pages、GitHub Pages、Nginx 等)。官方文档站部署在 Cloudflare Pages:

bash
npm run build
npx wrangler pages deploy .vitepress/dist --project-name assemblyai-hub-docs --branch main

文档版本 v3.4.0 · 与项目版本同步