feat: add auto-update functionality

Wangggym · Wangggym · commit 7bdccf6a3b26 · 2025-11-17T15:01:15.000+08:00
✨ Features:
- Auto-check for updates every 24 hours
- Auto-download and install new versions (configurable)
- Manual update command: qkflow update-cli
- Smart update detection from GitHub Releases
- Safe update with automatic backup and rollback
- Platform-specific binary download (macOS/Linux/Windows)

🔧 Configuration:
- Add auto_update config (default: true)
- Add github_owner and github_repo config
- Update init wizard to configure auto-update
- Support AUTO_UPDATE environment variable

📚 Documentation:
- Add AUTO_UPDATE.md guide
- Document all update features and workflows

🛡️ Safety:
- Background silent checking (non-blocking)
- Automatic backup before update
- Rollback on failure
- 24-hour check interval with timestamp file
diff --git a/go-version/AUTO_UPDATE.md b/go-version/AUTO_UPDATE.md
@@ -0,0 +1,234 @@
+# 自动更新功能
+
+## 概述
+
+qkflow 内置了智能的自动更新功能，可以确保你始终使用最新版本，享受最新特性和 bug 修复。
+
+## 特性
+
+- ✅ **自动检查更新** - 每24小时自动检查一次新版本
+- ✅ **后台静默运行** - 不影响当前命令的执行
+- ✅ **智能更新** - 发现新版本时自动下载并安装
+- ✅ **可配置** - 可以选择启用或禁用自动更新
+- ✅ **手动更新** - 随时可以手动触发更新
+- ✅ **安全备份** - 更新失败时自动恢复旧版本
+
+## 工作原理
+
+### 1. 自动检查
+
+每次运行 qkflow 命令时（除了 `init`、`version`、`help`、`update-cli`），系统会：
+
+1. 检查距离上次检查更新是否已超过 24 小时
+2. 如果是，则在后台检查 GitHub Releases 的最新版本
+3. 比较当前版本和最新版本
+
+### 2. 自动更新（默认开启）
+
+如果发现新版本且启用了自动更新：
+
+```bash
+🎉 New version available: v1.1.0 (current: v1.0.0)
+⬇️  Downloading update...
+✅ Successfully updated to version v1.1.0! Please restart qkflow.
+```
+
+系统会：
+1. 从 GitHub Releases 下载对应平台的二进制文件
+2. 备份当前版本
+3. 替换为新版本
+4. 提示重启 qkflow
+
+### 3. 手动更新模式
+
+如果禁用了自动更新，只会提示：
+
+```bash
+🎉 New version available: v1.1.0 (current: v1.0.0)
+Run 'qkflow update-cli' to update, or visit: https://github.com/Wangggym/quick-workflow/releases
+```
+
+## 配置自动更新
+
+### 初始化时配置
+
+运行 `qkflow init` 时会询问：
+
+```bash
+Enable automatic updates? (recommended) [Y/n]:
+```
+
+- 按 `Y` 或 直接回车：启用自动更新（推荐）
+- 按 `n`：禁用自动更新
+
+### 修改配置
+
+编辑配置文件 `~/.qkflow/config.yaml`（或 iCloud Drive 路径）：
+
+```yaml
+# 启用自动更新（推荐）
+auto_update: true
+
+# 或禁用自动更新
+auto_update: false
+```
+
+修改后，下次运行 qkflow 命令时生效。
+
+### 使用环境变量
+
+```bash
+# 临时禁用自动更新
+export AUTO_UPDATE=false
+qkflow pr create
+
+# 临时启用自动更新
+export AUTO_UPDATE=true
+qkflow pr create
+```
+
+## 手动更新
+
+随时可以手动检查并更新到最新版本：
+
+```bash
+qkflow update-cli
+```
+
+这会：
+1. 立即检查最新版本
+2. 如果有新版本，下载并安装
+3. 如果已是最新版本，显示确认信息
+
+示例输出：
+
+```bash
+# 有新版本
+🎉 New version available: v1.1.0 (current: v1.0.0)
+⬇️  Downloading update...
+✅ Successfully updated to version v1.1.0! Please restart qkflow.
+
+# 已是最新版本
+✅ You are already running the latest version (v1.0.0)
+```
+
+## 更新频率
+
+- **检查频率**: 每 24 小时检查一次
+- **时间戳文件**: `~/.qkflow/.last_update_check`
+- **超时设置**: API 请求 5 秒超时，下载 5 分钟超时
+
+可以手动删除时间戳文件来强制立即检查：
+
+```bash
+rm ~/.qkflow/.last_update_check
+```
+
+## 支持的平台
+
+自动更新支持所有 qkflow 支持的平台：
+
+- ✅ macOS (Intel) - `qkflow-darwin-amd64`
+- ✅ macOS (Apple Silicon) - `qkflow-darwin-arm64`
+- ✅ Linux (amd64) - `qkflow-linux-amd64`
+- ✅ Windows (amd64) - `qkflow-windows-amd64.exe`
+
+## 安全性
+
+### 下载来源
+
+- 所有二进制文件从 GitHub Releases 官方下载
+- URL: `https://api.github.com/repos/Wangggym/quick-workflow/releases/latest`
+- 使用 HTTPS 加密传输
+
+### 更新流程
+
+1. 下载到临时文件
+2. 设置可执行权限
+3. 备份当前版本 (`qkflow.backup`)
+4. 替换为新版本
+5. 删除备份文件
+6. 如果失败，自动恢复备份
+
+### 权限要求
+
+更新需要对二进制文件所在目录有写权限：
+
+- 如果安装在 `/usr/local/bin/`，需要 sudo 权限
+- 如果安装在 `~/bin/` 或 `GOPATH/bin`，不需要特殊权限
+
+## 常见问题
+
+### Q: 自动更新会中断我的工作吗？
+
+A: 不会。更新检查在后台运行，不阻塞当前命令。只有在下载完成后才会提示重启。
+
+### Q: 更新失败怎么办？
+
+A: 系统会自动恢复备份。你可以手动运行 `qkflow update-cli` 重试，或访问 GitHub Releases 手动下载。
+
+### Q: 如何查看当前版本？
+
+```bash
+qkflow version
+```
+
+### Q: 如何禁用自动更新？
+
+编辑 `~/.qkflow/config.yaml`：
+
+```yaml
+auto_update: false
+```
+
+或使用环境变量：
+
+```bash
+export AUTO_UPDATE=false
+```
+
+### Q: 能否回滚到旧版本？
+
+可以。访问 [GitHub Releases](https://github.com/Wangggym/quick-workflow/releases) 下载特定版本的二进制文件，手动替换即可。
+
+### Q: 自动更新失败会显示错误吗？
+
+A: 不会。为了不影响用户体验，更新失败时静默处理。可以手动运行 `qkflow update-cli` 查看详细错误。
+
+## 最佳实践
+
+1. **推荐启用自动更新** - 确保始终使用最新版本，享受最新特性和 bug 修复
+
+2. **定期手动检查** - 如果禁用了自动更新，建议定期运行：
+   ```bash
+   qkflow update-cli
+   ```
+
+3. **在重要操作前更新** - 在执行重要操作前，确保使用最新版本：
+   ```bash
+   qkflow update-cli
+   qkflow pr create
+   ```
+
+4. **CI/CD 环境** - 在 CI/CD 中，建议禁用自动更新，使用固定版本：
+   ```bash
+   export AUTO_UPDATE=false
+   ```
+
+## 更新日志
+
+查看完整的更新历史和版本说明：
+
+👉 [GitHub Releases](https://github.com/Wangggym/quick-workflow/releases)
+
+## 反馈
+
+如果在使用自动更新功能时遇到问题，请：
+
+- 🐛 [报告 Bug](https://github.com/Wangggym/quick-workflow/issues/new?labels=bug)
+- 💡 [提出建议](https://github.com/Wangggym/quick-workflow/issues/new?labels=enhancement)
+
+---
+
+**享受无缝的自动更新体验！** 🚀
+
diff --git a/go-version/cmd/qkflow/commands/init.go b/go-version/cmd/qkflow/commands/init.go
@@ -48,6 +48,22 @@ func runInit(cmd *cobra.Command, args []string) {
 	}
 	cfg.GitHubToken = ghToken
 
+	// GitHub Owner
+	githubOwner, err := ui.PromptInput("Enter your GitHub username or organization:", true)
+	if err != nil {
+		ui.Error(fmt.Sprintf("Failed to get GitHub owner: %v", err))
+		return
+	}
+	cfg.GitHubOwner = githubOwner
+
+	// GitHub Repo
+	githubRepo, err := ui.PromptInput("Enter your GitHub repository name:", true)
+	if err != nil {
+		ui.Error(fmt.Sprintf("Failed to get GitHub repo: %v", err))
+		return
+	}
+	cfg.GitHubRepo = githubRepo
+
 	// Jira Service Address
 	jiraAddr, err := ui.PromptInput("Enter your Jira service address (e.g., https://your-domain.atlassian.net):", true)
 	if err != nil {
@@ -82,6 +98,19 @@ func runInit(cmd *cobra.Command, args []string) {
 		}
 	}
 
+	// Auto Update (default: true)
+	autoUpdate, err := ui.PromptConfirm("Enable automatic updates? (recommended)", true)
+	if err == nil {
+		cfg.AutoUpdate = autoUpdate
+	} else {
+		cfg.AutoUpdate = true // Default to true
+	}
+	if cfg.AutoUpdate {
+		ui.Success("✅ Auto-update enabled - qkflow will keep itself up to date")
+	} else {
+		ui.Info("ℹ️  Auto-update disabled - run 'qkflow update-cli' to update manually")
+	}
+
 	// Save configuration
 	if err := config.Save(cfg); err != nil {
 		ui.Error(fmt.Sprintf("Failed to save configuration: %v", err))
@@ -101,9 +130,11 @@ func runInit(cmd *cobra.Command, args []string) {
 	fmt.Println()
 	
 	ui.Info("You can now use the following commands:")
-	fmt.Println("  qkflow pr create  - Create a PR and update Jira")
-	fmt.Println("  qkflow pr merge   - Merge a PR and update Jira")
-	fmt.Println("  qkflow update     - Quick commit and push with PR title")
+	fmt.Println("  qkflow pr create   - Create a PR and update Jira")
+	fmt.Println("  qkflow pr merge    - Merge a PR and update Jira")
+	fmt.Println("  qkflow update      - Quick commit and push with PR title")
+	fmt.Println("  qkflow update-cli  - Update qkflow to the latest version")
+	fmt.Println("  qkflow jira list   - List Jira status mappings")
 	fmt.Println()
 }
 
diff --git a/go-version/cmd/qkflow/commands/root.go b/go-version/cmd/qkflow/commands/root.go
@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	"github.com/Wangggym/quick-workflow/internal/ui"
+	"github.com/Wangggym/quick-workflow/internal/updater"
 	"github.com/Wangggym/quick-workflow/internal/utils"
 	"github.com/Wangggym/quick-workflow/pkg/config"
 	"github.com/spf13/cobra"
@@ -22,16 +23,17 @@ var rootCmd = &cobra.Command{
 	Long: `qkflow is a CLI tool to streamline your GitHub and Jira workflow.
 It automates common tasks like creating PRs, updating Jira status, and more.`,
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
-		// 对于某些命令不需要检查配置
-		skipConfigCheck := []string{"init", "version", "help"}
+		// 对于某些命令不需要检查配置和更新
+		skipConfigCheck := []string{"init", "version", "help", "update-cli"}
 		for _, skip := range skipConfigCheck {
 			if cmd.Name() == skip || cmd.Parent().Name() == skip {
 				return
 			}
 		}
 
 		// 检查配置
-		if _, err := config.Load(); err != nil {
+		cfg, err := config.Load()
+		if err != nil {
 			ui.Error(fmt.Sprintf("Failed to load config: %v", err))
 			ui.Warning("Please run 'qkflow init' to configure the tool")
 			return
@@ -40,6 +42,13 @@ It automates common tasks like creating PRs, updating Jira status, and more.`,
 		if !config.IsConfigured() {
 			ui.Warning("Configuration incomplete. Please run 'qkflow init' to complete setup")
 		}
+
+		// 检查更新（后台静默执行，不阻塞主流程）
+		go func() {
+			if err := updater.CheckAndUpdate(Version, cfg.AutoUpdate); err != nil {
+				// 静默失败，不影响主流程
+			}
+		}()
 	},
 }
 
diff --git a/go-version/cmd/qkflow/commands/update_cli.go b/go-version/cmd/qkflow/commands/update_cli.go
@@ -0,0 +1,23 @@
+package commands
+
+import (
+	"github.com/Wangggym/quick-workflow/internal/updater"
+	"github.com/spf13/cobra"
+)
+
+var updateCLICmd = &cobra.Command{
+	Use:   "update-cli",
+	Short: "Update qkflow to the latest version",
+	Long:  `Check for updates and install the latest version of qkflow.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		if err := updater.ManualUpdate(Version); err != nil {
+			cmd.PrintErrf("Failed to update: %v\n", err)
+			return
+		}
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(updateCLICmd)
+}
+
diff --git a/go-version/internal/updater/updater.go b/go-version/internal/updater/updater.go
diff --git a/go-version/pkg/config/config.go b/go-version/pkg/config/config.go
