发布流程

本页介绍项目的版本发布流程。

版本号规则

使用语义化版本 (SemVer)：主版本.次版本.修订版本

类型	说明	示例
主版本	不兼容的 API 变更	1.0.0 → 2.0.0
次版本	向下兼容的功能新增	1.0.0 → 1.1.0
修订版本	向下兼容的问题修复	1.0.0 → 1.0.1

发布步骤

1. 更新版本号

编辑 package.json：

{
  "version": "1.2.3"
}

2. 更新 CHANGELOG

在 CHANGELOG.md 中添加新版本的更新内容。

3. 提交代码

git add -A
git commit -m "release: v1.2.3"

4. 创建 Tag

git tag v1.2.3

5. 推送

git push origin main
git push origin v1.2.3

6. 自动构建

推送 tag 后，GitHub Actions 会自动：

1. 构建 Windows 安装包（x64 和 ia32）
2. 创建 GitHub Release
3. 上传安装包到 Release

GitHub Actions

触发条件

事件	行为
push 到 main	仅构建，不发布
push tag (v*)	构建并发布到 Releases
workflow_dispatch	手动触发构建

工作流配置

# .github/workflows/build-release.yml
name: Build and Release

on:
  push:
    branches: [main]
    tags: ['v*']
  workflow_dispatch:

jobs:
  build:
    runs-on: windows-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
      - run: npm ci
      - run: npm run electron:build:win
      - uses: softprops/action-gh-release@v1
        if: startsWith(github.ref, 'refs/tags/')
        with:
          files: dist/*.exe

构建产物

文件	说明
文言文查询-Setup-x.x.x-x64.exe	64 位安装包
文言文查询-Setup-x.x.x-ia32.exe	32 位安装包

快速发布脚本

项目提供了快速发布脚本：

# 发布修订版本
npm run release:patch

脚本会自动：

1. 递增版本号
2. 提交代码
3. 创建 tag
4. 推送到 GitHub

注意事项

• 发布前确保所有测试通过
• 更新 CHANGELOG
• 检查是否有未提交的改动
• Tag 名称必须以 v 开头