ssh-release 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.6.0 - 2026-06-25
+
+### Added
+
+- 增加 `ssh-release deploy --json --progress`，发布时按 NDJSON 输出 `source`、`lock`、`package`、`publish`、`cleanup` 阶段状态，并在最后输出发布结果。
+
 ## 0.5.0 - 2026-06-25
 
 ### Added

package/README.md

@@ -17,6 +17,7 @@
 - `ssh-release rollback [version]`：回滚到上一个版本或指定版本。
 - `ssh-release unlock`：查看远端锁，并在显式确认锁路径后删除锁。
 - `--json`：输出单行 JSON，便于 CI/CD 解析。
+- `deploy --json --progress`：发布时输出 NDJSON 阶段进度，便于 CI/CD 展示实时状态。
 - `release` 模式：上传压缩包、远端解压、切换 `current`、清理旧版本。
 - `overwrite` 模式：直接覆盖发布到目标目录。
 - 远端 `tar` 解压失败时回退逐文件上传。
@@ -231,6 +232,7 @@ ssh-release rollback 20260625-150000
 
 ```bash
 ssh-release deploy --dry-run --json
+ssh-release deploy --json --progress
 ssh-release doctor --json
 ssh-release list --json
 ssh-release rollback --json
@@ -249,6 +251,22 @@ ssh-release unlock --json
 {"ok":false,"command":"deploy","error":"错误信息"}
 ```
 
+发布时需要持续读取阶段状态，可以使用：
+
+```bash
+ssh-release deploy --json --progress
+```
+
+该模式会按行输出 NDJSON。进度事件先输出，最终结果最后输出：
+
+```json
+{"ok":true,"command":"deploy","event":"progress","stage":"package","status":"start"}
+{"ok":true,"command":"deploy","event":"progress","stage":"package","status":"success"}
+{"ok":true,"command":"deploy","result":{"mode":"release","version":"20260625-153000"}}
+```
+
+`stage` 可能是 `source`、`lock`、`package`、`publish`、`cleanup`，`status` 可能是 `start`、`success`、`fail`。失败事件会包含 `error` 字段。
+
 `doctor` 检查失败、`unlock` 发现锁但未删除时会返回非零退出码，并在 JSON 的 `result` 中保留检查结果。
 
 ## 安全边界

package/dist/cli.js

@@ -5,7 +5,7 @@ import { fileURLToPath } from 'node:url';
 import { CONFIG_FILE_NAME, loadConfigFile, writeConfigTemplate } from './config.js';
 import { runDoctorFromFile } from './doctor.js';
 import { listReleases } from './list.js';
-import { createDeployPlan, deploy } from './release.js';
+import { createDeployPlan, deploy, } from './release.js';
 import { rollback } from './rollback.js';
 import { createRemoteClient } from './ssh.js';
 import { unlock } from './unlock.js';
@@ -57,7 +57,13 @@ export async function runCli(argv = process.argv.slice(2), options = {}) {
             return 0;
         }
         if (command === 'deploy') {
-            const result = await handlers.deploy({ dryRun: parsed.dryRun });
+            const deployOptions = {
+                dryRun: parsed.dryRun,
+            };
+            if (parsed.json && parsed.progress) {
+                deployOptions.onProgress = (event) => printJsonProgress('deploy', event, io);
+            }
+            const result = await handlers.deploy(deployOptions);
             if (parsed.json) {
                 printJsonResult('deploy', result, 0, io);
                 return 0;
@@ -130,6 +136,7 @@ function parseCliArgs(argv) {
     let dryRun = false;
     let help = false;
     let json = false;
+    let progress = false;
     let version = false;
     for (let index = 0; index < argv.length; index += 1) {
         const arg = argv[index];
@@ -145,6 +152,10 @@ function parseCliArgs(argv) {
             json = true;
             continue;
         }
+        if (arg === '--progress') {
+            progress = true;
+            continue;
+        }
         if (arg === '--config' || arg === '-c') {
             const value = argv[index + 1];
             if (!value || value.startsWith('-')) {
@@ -172,6 +183,12 @@ function parseCliArgs(argv) {
         }
         args.push(arg);
     }
+    if (progress && !json) {
+        return createParsedError('--progress 需要配合 --json 使用', configPath, json);
+    }
+    if (progress && args[0] && args[0] !== 'deploy') {
+        return createParsedError('--progress 仅支持 deploy 命令', configPath, json);
+    }
     return {
         args: args.slice(1),
         command: args[0],
@@ -180,6 +197,7 @@ function parseCliArgs(argv) {
         dryRun,
         help,
         json,
+        progress,
         version,
     };
 }
@@ -191,6 +209,7 @@ function createParsedError(error, configPath, json = false) {
         error,
         help: false,
         json,
+        progress: false,
         version: false,
     };
 }
@@ -202,7 +221,9 @@ function createDefaultHandlers(configPath) {
             if (options?.dryRun) {
                 return createDeployPlan(config);
             }
-            return deploy(config, createRemoteClient(config));
+            return deploy(config, createRemoteClient(config), {
+                onProgress: options?.onProgress,
+            });
         },
         rollback: async (version) => {
             const config = await loadConfigFile(configPath);
@@ -298,6 +319,14 @@ function printJsonResult(command, result, exitCode, io) {
         result,
     }));
 }
+function printJsonProgress(command, event, io) {
+    io.log(JSON.stringify({
+        ok: true,
+        command,
+        event: 'progress',
+        ...event,
+    }));
+}
 function printJsonError(command, error, io) {
     io.log(JSON.stringify({
         ok: false,
@@ -322,6 +351,7 @@ function createUsageText() {
   ssh-release doctor [--config <path>]
   ssh-release deploy [--config <path>]
   ssh-release deploy --dry-run [--config <path>]
+  ssh-release deploy --json --progress [--config <path>]
   ssh-release list [--config <path>]
   ssh-release rollback [version] [--config <path>]
   ssh-release unlock [--confirm <lock-path>] [--config <path>]

package/dist/release.js

@@ -28,25 +28,25 @@ function pad(value) {
     return value.toString().padStart(2, '0');
 }
 export async function deploy(config, client, options = {}) {
-    await ensureSourceExists(config.source.path);
+    await withDeployProgress(options, 'source', () => ensureSourceExists(config.source.path));
     const versionName = createVersionName(options.now ?? new Date());
     const packageFactory = options.createPackage ?? createReleasePackage;
-    const releaseLock = await acquireRemoteLock(config, client);
+    const releaseLock = await withDeployProgress(options, 'lock', () => acquireRemoteLock(config, client));
     let releasePackage;
     let result;
     let deployError;
     let cleanupError;
     try {
-        releasePackage = await packageFactory({
+        releasePackage = await withDeployProgress(options, 'package', () => packageFactory({
             sourcePath: config.source.path,
             exclude: config.source.exclude,
             versionName,
-        });
+        }));
         if (config.deploy.mode === 'overwrite') {
-            result = await deployOverwrite(config, client, releasePackage, versionName);
+            result = await withDeployProgress(options, 'publish', () => deployOverwrite(config, client, releasePackage, versionName));
             return result;
         }
-        result = await deployRelease(config, client, releasePackage, versionName);
+        result = await withDeployProgress(options, 'publish', () => deployRelease(config, client, releasePackage, versionName));
         return result;
     }
     catch (error) {
@@ -54,29 +54,31 @@ export async function deploy(config, client, options = {}) {
         throw error;
     }
     finally {
-        if (releasePackage) {
+        await withDeployProgress(options, 'cleanup', async () => {
+            if (releasePackage) {
+                try {
+                    await releasePackage.cleanup();
+                }
+                catch (error) {
+                    cleanupError = error;
+                }
+            }
             try {
-                await releasePackage.cleanup();
+                await releaseLock();
             }
             catch (error) {
-                cleanupError = error;
+                const message = `远程发布锁清理失败: ${formatError(error)}`;
+                if (result) {
+                    result.warnings.push(message);
+                }
+                else if (!deployError && !cleanupError) {
+                    cleanupError = error;
+                }
             }
-        }
-        try {
-            await releaseLock();
-        }
-        catch (error) {
-            const message = `远程发布锁清理失败: ${formatError(error)}`;
-            if (result) {
-                result.warnings.push(message);
+            if (cleanupError && !deployError) {
+                throw cleanupError;
             }
-            else if (!deployError && !cleanupError) {
-                cleanupError = error;
-            }
-        }
-        if (cleanupError && !deployError) {
-            throw cleanupError;
-        }
+        });
     }
 }
 export async function createDeployPlan(config, options = {}) {
@@ -191,3 +193,22 @@ async function ensureSourceExists(sourcePath) {
 function formatError(error) {
     return error instanceof Error ? error.message : String(error);
 }
+async function withDeployProgress(options, stage, run) {
+    await emitDeployProgress(options, { stage, status: 'start' });
+    try {
+        const result = await run();
+        await emitDeployProgress(options, { stage, status: 'success' });
+        return result;
+    }
+    catch (error) {
+        await emitDeployProgress(options, {
+            stage,
+            status: 'fail',
+            error: formatError(error),
+        });
+        throw error;
+    }
+}
+async function emitDeployProgress(options, event) {
+    await options.onProgress?.(event);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-release",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "A general-purpose SSH file release CLI.",
   "type": "module",
   "bin": {