跳转至

打包与发布指南

本文档说明如何打包和发布 WatchCat 应用。

打包流程

WatchCat 使用 PyInstaller 进行打包,通过 GitHub Actions 自动构建各个平台的发布版本。

本地打包测试

在本地进行打包测试时,请确保已安装所有依赖:

# 安装项目依赖
poetry install --with dev

# 使用 PyInstaller 打包(使用配置文件)
poetry run pyinstaller watchcat.spec

打包后的文件将在 dist/WatchCat 目录下生成。在 macOS 系统上,你可以通过以下方式运行打包后的程序:

  1. 命令行方式:

    cd dist/WatchCat
    ./WatchCat
    
  2. 图形界面方式: 在 Finder 中打开 dist/WatchCat 目录,双击 WatchCat 应用程序

注意:如果遇到通知功能不工作的问题,请确保 watchcat.spec 文件中包含了以下配置:

datas=[
    ('default_config.json', '.'),
    ('resources', 'resources'),
    ('venv/lib/python3.12/site-packages/notifypy/os_notifiers/binaries/Notificator.app', 'notifypy/os_notifiers/binaries'),
],

发布新版本

  1. 更新版本号

    poetry version [patch|minor|major]
    
  2. 提交变更并创建标签

    git add pyproject.toml
    git commit -m "chore: bump version to $(poetry version -s)"
    git tag "v$(poetry version -s)"
    git push origin main --tags
    
  3. GitHub Actions 将自动构建以下格式的发布包:

  4. Windows: .exe
  5. macOS: .dmg
  6. Linux: 可执行文件

平台特定说明

Windows

Windows 版本会打包成单个 .exe 文件,用户可以直接运行。

macOS

macOS 版本打包为 .dmg 格式,用户可以: 1. 双击打开 DMG 文件 2. 将应用拖拽到 Applications 文件夹 3. 从 Applications 文件夹启动应用

Linux

Linux 版本打包为单个可执行文件,用户需要: 1. 添加执行权限:chmod +x watchcat-linux 2. 运行程序:./watchcat-linux

注意事项

  1. 发布前确保:
  2. 所有测试通过
  3. 更新日志已更新
  4. 文档已更新

  5. 版本号规范:

  6. 遵循语义化版本 (Semantic Versioning)
  7. 格式:MAJOR.MINOR.PATCH
  8. 示例:v1.2.3