EnlightenCode

GitHub Releases 应用发布指南 🚀 ​

Releases 简介 📝 ​

GitHub Releases 是一个强大的版本发布功能，它可以帮助开发者更好地管理和发布软件版本。本文将详细介绍如何使用这个功能。

发布前准备工作 ✅ ​

  1. 确保代码已经完成测试
  2. 更新版本号（package.json）
  3. 生成更新日志
  4. 准备各平台安装包

Release 核心要素 🎯 ​

1. 版本标签（Choose a tag） ​

markdown
- 作用：标识具体版本号
- 推荐格式：v1.0.0 或 app-name-v1.0.0
- 示例：now-v1.0.0、electron-v2.1.0
- 遵循语义化版本（Semantic Versioning）
  - 主版本号.次版本号.修订号
  - 例如：1.0.0、2.1.3

2. 发布目标（Target） ​

markdown
- 选择要发布的代码分支或提交
- 建议选择稳定分支（main/master）
- 特殊情况可选择特定commit
- 确保代码已经完成充分测试

3. 发布标题（Release title） ​

markdown
- 清晰表达版本信息
- 推荐格式：应用名 v版本号 - 版本特征
- 示例：
  - Now v1.0.0 - 首次正式发布
  - Now v1.1.0 - 性能优化更新

4. 发布说明（Release notes）📋 ​

markdown
建议包含以下内容：
1. 版本亮点概述
2. 新功能列表（✨ Features）
3. 问题修复（🐛 Bug Fixes）
4. 性能改进（⚡️ Performance）
5. 破坏性更新（⚠️ Breaking Changes）
6. 依赖更新（📦 Dependencies）

完整发布流程 🔄 ​

1. 准备发布文件 ​

markdown
确保准备好各平台安装包：
- Windows: 
  - Setup.exe（安装包）
  - zip（便携版）
- MacOS:
  - .dmg（镜像文件）
  - .zip（压缩包）
- Linux:
  - .AppImage（通用格式）
  - .deb（Debian系）
  - .rpm（RedHat系）

2. 创建新版本发布 ​

  1. 进入项目仓库
  2. 点击 "Releases"
  3. 选择 "Create a new release"
  4. 填写版本信息

3. 编写高质量发布说明 ​

markdown
## ✨ 新特性
- 添加深色模式支持
- 优化数据同步功能

## 🐛 问题修复
- 修复Windows下闪退问题
- 解决MacOS菜单栏显示异常

## ⚡️ 性能优化
- 提升启动速度30%
- 降低内存占用

## 📝 其他更新
- 更新Electron至最新版本
- 优化错误提示

4. 发布选项设置 ⚙️ ​

markdown
根据实际情况选择：
- ✅ Set as the latest release（设为最新版本）
  适用于正式版本发布
- ⚠️ Set as a pre-release（设为预发布版本）
  适用于测试版本
- 💬 Create a discussion（创建讨论）
  需要收集用户反馈时启用

注意事项 ⚠️ ​

  1. 版本号管理

    • 严格遵循语义化版本规范
    • 保持版本号递增
    • 不要随意修改已发布的版本

  2. 文件命名规范

    • 包含应用名称和版本号
    • 区分不同系统和架构
    • 保持命名一致性

  3. 发布说明书写

    • 使用清晰的分类
    • 详细描述重要更新
    • 标注破坏性更新
    • 包含升级指南（如需要）

  4. 安全考虑

    • 确保代码已经过安全审查
    • 移除敏感信息
    • 检查依赖包安全性

最佳实践 💡 ​

  1. 自动化发布流程

    • 使用GitHub Actions自动构建
    • 自动生成更新日志
    • 自动上传安装包

  2. 版本更新检查

    • 实现自动更新检测
    • 提供更新提醒
    • 支持一键更新

  3. 用户反馈收集

    • 开启GitHub Discussions
    • 及时响应用户反馈
    • 跟踪版本问题

相关资源 📚 ​