@taole/deploy-helper 0.3.4 → 0.3.6

package/index.mjs

@@ -5,7 +5,8 @@ import fs from 'fs';
 import { join, basename, dirname } from "path";
 import { simpleGit } from 'simple-git';
 import { homedir } from 'os'
-import { runPipeline, checkYunxiaoToken } from './lib/pipelineApi.mjs';
+import { runPipeline, checkYunxiaoToken, triggerPipeline } from './lib/pipelineApi.mjs';
+import { setDebug, log } from './lib/util.mjs';
 
 const TEST_SERVER_HOST = "192.168.0.35";
 /**
@@ -18,7 +19,7 @@ async function loadConfig() {
         const configJson = JSON.parse(fs.readFileSync(configJsonPath, "utf-8"));
         return configJson;
     }
-    console.log(`deploy.config.json不存在, 请先创建`);
+    log(`deploy.config.json不存在, 请先创建`);
     return null;
 }
 
@@ -26,7 +27,7 @@ async function initConfigJson() {
     // check if deploy.config.json exists
     const configJsonPath = join(process.cwd(), "deploy.config.json");
     if (fs.existsSync(configJsonPath)) {
-        console.log(`deploy.config.json已存在, 请勿重复创建`);
+        log(`deploy.config.json已存在, 请勿重复创建`);
         return;
     }
 
@@ -52,7 +53,7 @@ async function initConfigJson() {
     }
 }`;
     fs.writeFileSync(configJsonPath, content, { encoding: "utf-8" });
-    console.log(`deploy.config.json创建成功`);
+    log(`deploy.config.json创建成功`);
     process.exit(0);
 }
 
@@ -72,7 +73,7 @@ async function getScpClient() {
     if (fs.existsSync(sshKeyPath)) {
         scpClientConfig.privateKey = fs.readFileSync(sshKeyPath, "utf-8");
     } else {
-        console.log(`${sshKeyPath}不存在, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
+        log(`${sshKeyPath}不存在, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
     }
     scpClient = await Client(scpClientConfig);
     return scpClient;
@@ -83,13 +84,19 @@ async function getScpClient() {
 
 async function main() {
 
+    // process.argv.includes("--debug") || 
+    // 默认开启debug debug目前只是打印日志的时候额外打印时间
+    setDebug(true);
+
+    log("deploy-helper start");
+
     // await devTest();
-    // console.log(`process.argv: ${process.argv[2]} ${process.argv[3]} ${process.argv[4]}`);
+    // log(`process.argv: ${process.argv[2]} ${process.argv[3]} ${process.argv[4]}`);
 
     // return;
     // other commands
     let command = process.argv[2];
-    if (!["init", "prod", "test", "scp", "scpevt"].includes(command)) {
+    if (!["init", "prod", "test", "scp", "scpevt", "pipeline"].includes(command)) {
         command = "help";
     }
 
@@ -103,6 +110,7 @@ async function main() {
         console.log(`command: scp {file} {dest} 复制文件{file}到OfficialSite测试服务器{dest}`);
         console.log(`command: scpevt {file} 复制文件{file}到events测试服务器{file}`);
         console.log(`command: scpevt {file} {dest} 复制文件{file}到events测试服务器{dest}`);
+        log(`command: pipeline {pipelineName|pipelineId} 触发流水线{pipelineName|pipelineId}`);
         process.exit(0);
     } else if (command === "init") {
         await initConfigJson();
@@ -110,18 +118,18 @@ async function main() {
     } else if (["scp", "scpevt"].includes(command)) {
         const file = process.argv[3];
         if (!file) {
-            console.log(`file参数不能为空`);
+            log(`file参数不能为空`);
             process.exit(1);
         }
         const workDir = process.cwd(); // 当前项目根目录
 
         const srcFilePath = join(workDir, file);
         if (!fs.existsSync(srcFilePath)) {
-            console.log(`${srcFilePath}不存在`);
+            log(`${srcFilePath}不存在`);
             process.exit(1);
         }
         if (fs.statSync(srcFilePath).isDirectory()) {
-            console.log(`${srcFilePath}是目录, 不支持scp目录`);
+            log(`${srcFilePath}是目录, 不支持scp目录`);
             process.exit(1);
         }
         // 获取srcFilePath的目录
@@ -129,42 +137,56 @@ async function main() {
         const fileName = basename(srcFilePath);
         const dest = process.argv[4] || fileName;
         if (dest.includes("/") || dest.includes("\\")) {
-            console.log(`dest不能包含/或\\`);
+            log(`dest不能包含/或\\`);
             process.exit(1);
         }
 
         if (workDir !== fileDir) {
-            console.log(`仅支持scp当前目录下的文件(不带子目录)`);
+            log(`仅支持scp当前目录下的文件(不带子目录)`);
             process.exit(1);
         }
 
         const destPath = "/home/web/website/tuwan_www/templets/static/play/" + (command === 'scp' ? '' : 'events/') + dest;
 
         const scpClient = await getScpClient();
-        console.log(`scp: ${srcFilePath} -> ${TEST_SERVER_HOST}:${destPath}`);
+        log(`scp: ${srcFilePath} -> ${TEST_SERVER_HOST}:${destPath}`);
         await scpClient.uploadFile(srcFilePath, destPath);
-        console.log(`scp done.`);
+        log(`scp done.`);
         process.exit(0);
+    } else if (command === "pipeline") {
+        const pipelineName = process.argv[3];
+        if (!pipelineName) {
+            log(`pipeline参数不能为空`);
+            process.exit(1);
+        }
+        try {
+            await triggerPipeline(pipelineName);
+            process.exit(0);
+        } catch (error) {
+            log(`触发流水线失败: ${error}`);
+            process.exit(1);
+        }
+
     }
     try {
         const workDir = process.cwd(); // 当前项目根目录
         const mode = process.argv[2] === 'prod' ? 'prod' : 'test'; // 部署环境
-        console.log(`deploy mode: ${mode}`);
-        console.log(`workDir: ${workDir}`);
+        log(`deploy mode: ${mode}`);
+        log(`workDir: ${workDir}`);
 
         // 读取配置
         const config = await loadConfig();
-        // console.log(`config`, config);
+        // log(`config`, config);
 
         // 检查配置格式
         if (!config.assets || !config.assets.dest || !config.entry || !config.entry.dest) {
-            console.log(`配置格式错误, 请检查deploy.config.js或deploy.config.json`);
+            log(`配置格式错误, 请检查deploy.config.js或deploy.config.json`);
             return;
         }
 
         const result = hasChangeMe(JSON.stringify(config));
         if (result) {
-            console.log(`配置中存在默认值(CHANGE_ME), 请先修改配置`);
+            log(`配置中存在默认值(CHANGE_ME), 请先修改配置`);
             process.exit(1);
         }
 
@@ -186,12 +208,12 @@ async function main() {
         const assetsDest = join(workDir, config.assets.dest);
         const entryDest = join(workDir, config.entry.dest);
         if (!fs.existsSync(assetsDest)) {
-            console.log(`assets.dest路径不存在: ${assetsDest}, 请先创建`);
+            log(`assets.dest路径不存在: ${assetsDest}, 请先创建`);
             return;
         }
         // entry.dest
         if (needHandleEntry && !fs.existsSync(entryDest)) {
-            console.log(`entry.dest路径不存在: ${entryDest}, 请先创建`);
+            log(`entry.dest路径不存在: ${entryDest}, 请先创建`);
             return;
         }
 
@@ -199,7 +221,7 @@ async function main() {
         const assetsGit = simpleGit(assetsDest);
         let assetsStatus = await assetsGit.status();
         if (!assetsStatus.isClean()) {
-            console.log(`${assetsDest}目前有未提交内容, 请先处理`);
+            log(`${assetsDest}目前有未提交内容, 请先处理`);
             return;
         }
 
@@ -209,7 +231,7 @@ async function main() {
             entryGit = simpleGit(entryDest);
             entryStatus = await entryGit.status();
             if (!entryStatus.isClean()) {
-                console.log(`${entryDest}目前有未提交内容, 请先处理`);
+                log(`${entryDest}目前有未提交内容, 请先处理`);
                 return;
             }
         }
@@ -219,11 +241,11 @@ async function main() {
         //     const currentGit = simpleGit(workDir);
         //     const currentStatus = await currentGit.status();
         //     if (!currentStatus.isClean()) {
-        //         console.log(`当前项目有未提交内容, 请先处理`);
+        //         log(`当前项目有未提交内容, 请先处理`);
         //         process.exit(1);
         //     }
         //     if (currentStatus.branch !== currentProdBranch) {
-        //         console.log(`当前项目分支${currentStatus.branch}不是${currentProdBranch}分支, 请切换至${currentProdBranch}分支再执行prod命令`);
+        //         log(`当前项目分支${currentStatus.branch}不是${currentProdBranch}分支, 请切换至${currentProdBranch}分支再执行prod命令`);
         //         process.exit(1);
         //     }
         // }
@@ -231,14 +253,14 @@ async function main() {
         // 3. 检查assets项目分支，并切换至master分支
         // assets项目固定使用master分支
         if (assetsStatus.current !== "master") {
-            console.log(`${assetsDest}当前分支不是master, 切换至master分支`);
+            log(`${assetsDest}当前分支不是master, 切换至master分支`);
             await assetsGit.checkout("master");
-            console.log(`${assetsDest}切换至master分支成功`);
+            log(`${assetsDest}切换至master分支成功`);
         }
         if (needHandleEntry && entryStatus.current !== entryTargetBranch) {
-            console.log(`${entryDest}当前分支不是${entryTargetBranch}, 切换至${entryTargetBranch}分支`);
+            log(`${entryDest}当前分支不是${entryTargetBranch}, 切换至${entryTargetBranch}分支`);
             await entryGit.checkout(entryTargetBranch);
-            console.log(`${entryDest}切换至${entryTargetBranch}分支成功`);
+            log(`${entryDest}切换至${entryTargetBranch}分支成功`);
         }
 
         // 4. 执行git pull
@@ -254,7 +276,7 @@ async function main() {
         for (const [src, dest] of Object.entries(assetsFiles)) {
             const srcPath = join(workDir, src);
             if (!fs.existsSync(srcPath)) {
-                console.log(`${srcPath}不存在，请确认构建产物是否正确`);
+                log(`${srcPath}不存在，请确认构建产物是否正确`);
                 return;
             }
             const destPath = join(assetsDest, dest);
@@ -263,28 +285,28 @@ async function main() {
             } else {
                 fs.copyFileSync(srcPath, destPath);
             }
-            console.log(`assets copy: ${srcPath} -> ${destPath}`);
+            log(`assets copy: ${srcPath} -> ${destPath}`);
             assetsFilesCount++;
         }
-        // console.log(`assets copy done.`);
+        // log(`assets copy done.`);
         // 5.2 复制entry
         if (needHandleEntry) {
             const entryFiles = config.entry.files;
             for (const [src, dest] of Object.entries(entryFiles)) {
                 const srcPath = join(workDir, src);
                 if (!fs.existsSync(srcPath)) {
-                    console.log(`${srcPath}不存在，请确认构建产物是否正确`);
+                    log(`${srcPath}不存在，请确认构建产物是否正确`);
                     return;
                 }
                 if (fs.statSync(srcPath).isDirectory()) {
-                    console.log(`entry: ${srcPath}是目录，不支持entry为目录的部署`);
+                    log(`entry: ${srcPath}是目录，不支持entry为目录的部署`);
                     return;
                 }
                 const destPath = join(entryDest, dest);
                 fs.copyFileSync(srcPath, destPath);
-                console.log(`entry copy: ${srcPath} -> ${destPath}`);
+                log(`entry copy: ${srcPath} -> ${destPath}`);
             }
-            // console.log(`entry copy done.`);
+            // log(`entry copy done.`);
         }
 
         // 6. 提交
@@ -296,10 +318,10 @@ async function main() {
             await assetsGit.add(".");
             const assetsCommit = `${config.assets.commit || "feat:部署资源文件"} by deploy-helper`;
             const assetsCommitResult = await assetsGit.commit(assetsCommit);
-            console.log(`assets commit: ${assetsCommit}`);
-            console.log(`assets commit: ${JSON.stringify(assetsCommitResult.summary)}`);
+            log(`assets commit: ${assetsCommit}`);
+            log(`assets commit: ${JSON.stringify(assetsCommitResult.summary)}`);
         } else {
-            console.log(`${assetsDest} 未发现修改内容,跳过提交`);
+            log(`${assetsDest} 未发现修改内容,跳过提交`);
         }
 
         if (needHandleEntry) {
@@ -309,10 +331,10 @@ async function main() {
                 await entryGit.add(".");
                 const entryCommit = `${config.entry.commit || "feat:部署入口文件"} by deploy-helper`;
                 const entryCommitResult = await entryGit.commit(entryCommit);
-                console.log(`entry commit: ${entryCommit}`);
-                console.log(`entry commit: ${JSON.stringify(entryCommitResult.summary)}`);
+                log(`entry commit: ${entryCommit}`);
+                log(`entry commit: ${JSON.stringify(entryCommitResult.summary)}`);
             } else {
-                console.log(`${entryDest} 未发现修改内容,跳过提交`);
+                log(`${entryDest} 未发现修改内容,跳过提交`);
             }
         }
 
@@ -323,7 +345,7 @@ async function main() {
             } catch (error) {
                 await assetsGit.push();
             }
-            console.log(`assets push done.`);
+            log(`assets push done.`);
         }
         if (canPushEntry) {
             try {
@@ -331,7 +353,7 @@ async function main() {
             } catch (error) {
                 await entryGit.push();
             }
-            console.log(`entry push done.`);
+            log(`entry push done.`);
         }
 
         try {
@@ -342,15 +364,15 @@ async function main() {
                 for (const [src, dest] of Object.entries(syncTestFiles)) {
                     const srcPath = join(workDir, src);
                     const destPath = "/home/web/website/tuwan_www/templets/static/play/" + dest;
-                    console.log(`scp: ${srcPath} -> ${TEST_SERVER_HOST}:${destPath}`);
+                    log(`scp: ${srcPath} -> ${TEST_SERVER_HOST}:${destPath}`);
                     await scpClient.uploadFile(srcPath, destPath)
                 }
             }
         } catch (error) {
-            console.log(`scp error: ${error}`);
-            console.log(`复制文件到测试环境服务器失败, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
+            log(`scp error: ${error}`);
+            log(`复制文件到测试环境服务器失败, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
             if (assetsFilesCount > 0) {
-                console.log(`不过请放心，构建产物的assets已经处理完成，只要手动处理index.html文件即可。`);
+                log(`不过请放心，构建产物的assets已经处理完成，只要手动处理index.html文件即可。`);
             }
             process.exit(1);
         }
@@ -359,11 +381,11 @@ async function main() {
         // 处理触发流水线的任务
         await runPipeline(config, mode);
 
-        console.log(`deploy-helper deploy done.`);
+        log(`deploy-helper deploy done.`);
         process.exit(0);
 
     } catch (error) {
-        console.log(`error occurred in deploy-helper`, error);
+        log(`error occurred in deploy-helper`, error);
         process.exit(1);
     }
 }

package/lib/pipelineApi.mjs

@@ -2,8 +2,9 @@ import { homedir } from 'node:os';
 import { join } from 'node:path';
 import fs from 'node:fs';
 import simpleGit from 'simple-git';
+import { log, isDebug } from './util.mjs';
 
-import { createPipelineRunFunc, getLatestPipelineRunFunc, listPipelinesFunc } from '../modules/alibabacloud-devops-mcp-server/dist/operations/flow/pipeline.js'
+import { createPipelineRunFunc, listPipelinesFunc, getPipelineFunc } from '../modules/alibabacloud-devops-mcp-server/dist/operations/flow/pipeline.js'
 
 export const organizationId = "5ec8bb7bd1d1abe63b55cd33";
 
@@ -35,7 +36,7 @@ export function getYunxiaoToken(pipelineConfig) {
     if (devToken) {
         if (isFirstFoundToken) {
             isFirstFoundToken = false;
-            console.log(`将使用devToken`);
+            log(`将使用devToken`);
         }
         return devToken;
     }
@@ -45,7 +46,7 @@ export function getYunxiaoToken(pipelineConfig) {
         if (token) {
             if (isFirstFoundToken) {
                 isFirstFoundToken = false;
-                console.log(`将使用来自环境变量YUNXIAO_ACCESS_TOKEN的云效token`);
+                log(`将使用来自环境变量YUNXIAO_ACCESS_TOKEN的云效token`);
             }
             return token;
         }
@@ -62,7 +63,7 @@ export function getYunxiaoToken(pipelineConfig) {
         if (token) {
             if (isFirstFoundToken) {
                 isFirstFoundToken = false;
-                console.log(`将使用来自${userDeployHelperDir}的云效token`);
+                log(`将使用来自${userDeployHelperDir}的云效token`);
             }
             return token;
         }
@@ -83,14 +84,34 @@ async function getPipelineInfoByName(name) {
             pipeline = pipelines.items.find(item => item.name === name);
         }
     } catch (error) {
-        throw new Error(`获取流水线信息失败, 请确认流水线名称: ${name} 是否正确或检查云效token的权限是否足够: ${error}`);
+        throw new Error(`获取流水线信息失败, 请确认流水线名称:【${name}】是否正确或检查云效token的权限是否足够: ${error}`);
     }
     if (!pipeline) {
-        throw new Error(`未找到对应的流水线, 请确认流水线名称: ${name} 是否正确或检查云效token的权限是否足够`);
+        throw new Error(`未找到对应的流水线, 请确认流水线名称:【${name}】是否正确或检查云效token的权限是否足够`);
     }
     return pipeline;
 }
 
+export async function triggerPipeline(pipelineName) {
+    const yunxiaoToken = getYunxiaoToken({});
+    if(!yunxiaoToken) {
+        throw new Error(`未设置云效token， 请检查云效token是否正确`);
+    }
+    let pipelineID = "";
+    let name = pipelineName;
+    if(/^\d+$/.test(pipelineName)) {
+        pipelineID = pipelineName;
+        const pipelineInfo = await getPipelineFunc(organizationId, pipelineID);
+        name = pipelineInfo.name;
+    } else {
+        const pipelineInfo = await getPipelineInfoByName(pipelineName);
+        pipelineID = pipelineInfo.id;
+        name = pipelineInfo.name;
+    }
+    const runId = await createPipelineRunFunc(organizationId, pipelineID, {});
+    const pipelineRunDetailUrl = `https://flow.aliyun.com/pipelines/${pipelineID}/builds/${runId}`;
+    log(`流水线${name}[${pipelineID}]触发成功，流水线执行id: ${runId}， 流水线执行详情: ${pipelineRunDetailUrl}`);
+}
 
 
 /**
@@ -125,14 +146,14 @@ export function checkYunxiaoToken(config, mode) {
 }
 
 async function runSinglePipeline(pipeline, index, total) {
-    console.log(`开始处理流水线: ${pipeline.name}， 当前是第${index + 1}个， 总共${total}个`);
+    log(`开始处理流水线: ${pipeline.name}， 当前是第${index + 1}个， 总共${total}个`);
     let pipelineId = pipeline.id || "";
     if (!pipelineId) {
         // 获取流水线信息
         const pipelineInfo = await getPipelineInfoByName(pipeline.name);
         pipelineId = pipelineInfo.id;
     }
-    console.log(`流水线${pipeline.name}的id: ${pipelineId}`);
+    log(`流水线${pipeline.name}的id: ${pipelineId}`);
 
     // 处理分支强推的问题
     const force2Branch = pipeline.force2Branch;
@@ -140,32 +161,32 @@ async function runSinglePipeline(pipeline, index, total) {
         let repo = pipeline.repo || "./";
         repo = join(process.cwd(), repo);
         if (!fs.existsSync(repo)) {
-            console.log(`仓库${repo}有未提交的修改， 跳过流水线处理`);
+            log(`仓库${repo}有未提交的修改， 跳过流水线处理`);
             return;
         }   
         // 强推到指定分支
         const git = simpleGit(repo);
         const gitStatus = await git.status();
         if (!gitStatus.isClean()) {
-            console.log(`仓库${repo}有未提交的修改， 跳过流水线处理`);
+            log(`仓库${repo}有未提交的修改， 跳过流水线处理`);
             return;
         }
         if (gitStatus.current !== force2Branch.src) {
-            console.log(`仓库${repo}当前分支不是${force2Branch.src}， 切换到${force2Branch.src}`);
+            log(`仓库${repo}当前分支不是${force2Branch.src}， 切换到${force2Branch.src}`);
             await git.checkout(force2Branch.src);
-            console.log(`仓库${repo}切换到${force2Branch.src}完成`);
+            log(`仓库${repo}切换到${force2Branch.src}完成`);
         }
         await git.pull();
         await git.push();
         // git push origin master-test-0513:test --force
         await git.raw("push", "origin", `${force2Branch.src}:${force2Branch.dest}`, "--force");
-        console.log(`仓库${repo}强推${force2Branch.src}到${force2Branch.dest}完成`);
+        log(`仓库${repo}强推${force2Branch.src}到${force2Branch.dest}完成`);
     }
     // TODO: PERF: 获取流水线信息后， 可以缓存下来， 避免每次都重新获取
     // TODO: 触发流水线时， 可以传入参数， 比如分支， 比如环境, 但是不知道为什么覆盖不了。这里先不传了
     const runId = await createPipelineRunFunc(organizationId, pipelineId, {});
     const piplineRunDetailUrl = `https://flow.aliyun.com/pipelines/${pipelineId}/builds/${runId}`;
-    console.log(`流水线${pipeline.name}触发成功，流水线执行id: ${runId}， 流水线执行详情: ${piplineRunDetailUrl}`);
+    log(`流水线${pipeline.name}触发成功，流水线执行id: ${runId}， 流水线执行详情: ${piplineRunDetailUrl}`);
 }
 
 export async function runPipeline(config, mode) {
@@ -176,7 +197,7 @@ export async function runPipeline(config, mode) {
     }
     const token = getYunxiaoToken(pipelineConfig);
     if (!token) {
-        console.log(`未设置云效token, 此次流水线未自动执行: ${JSON.stringify(pipelineConfig)}`);
+        log(`未设置云效token, 此次流水线未自动执行: ${JSON.stringify(pipelineConfig)}`);
     }
     process.env.YUNXIAO_ACCESS_TOKEN = token;
 

package/lib/util.mjs

@@ -0,0 +1,17 @@
+let _isDebug = false;
+export function setDebug(debug) {
+    _isDebug = debug;
+}
+
+export function isDebug() {
+    return _isDebug;
+}
+
+export function log(...args) {
+    if (_isDebug) {
+        // 打印时间
+        console.log(`[${new Date().toLocaleString()}]`, ...args);
+    } else {
+        console.log(...args);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taole/deploy-helper",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "脚本部署工具，用于将项目部署到测试环境或生产环境",
   "main": "index.mjs",
   "type": "module",