@taole/deploy-helper 0.7.4-beta.6 → 0.7.5

package/index.mjs

@@ -1,21 +1,21 @@
 #!/usr/bin/env node
 
+import { Client } from 'node-scp'
 import fs from 'fs';
 import { join, basename, dirname } from "path";
 import { simpleGit } from 'simple-git';
+import { homedir } from 'os'
 import { runPipeline, checkYunxiaoToken, triggerPipeline } from './lib/pipelineApi.mjs';
-import { setDebug, log, getUserDeployHelperConfig, TEST_SERVER_HOST, getScpClient } from './lib/util.mjs';
+import { setDebug, log, getUserDeployHelperConfig } from './lib/util.mjs';
 import path from 'path';
 import { fileURLToPath } from 'url';
 import { checkOfflinePkg, syncApi as syncOfflinePkgApi } from './lib/offlinePkg.mjs';
-import tagRelease from './lib/tagRelease.mjs';
-
-
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
 
+const TEST_SERVER_HOST = "192.168.0.35";
 
 function fmtAssetsCommit(msg) {
     if (msg.startsWith("-#")) {
@@ -87,6 +87,25 @@ function hasChangeMe(content) {
     return content.includes("CHANGE_ME");
 }
 
+async function getScpClient() {
+    let scpClient = null;
+    // 不能放密码。。残念
+    const scpClientConfig = {
+        host: TEST_SERVER_HOST,
+        username: 'root',
+        tryKeyboard: false,
+        password: 'tuwan123!@#',
+    }
+    // const sshKeyPath = join(homedir(), ".ssh/id_rsa");
+    // if (fs.existsSync(sshKeyPath)) {
+    //     scpClientConfig.privateKey = fs.readFileSync(sshKeyPath, "utf-8");
+    // } else {
+    //     log(`${sshKeyPath}不存在, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
+    // }
+    scpClient = await Client(scpClientConfig);
+    return scpClient;
+}
+
 async function getVersion() {
     const packageJsonPath = join(__dirname, "package.json");
     const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
@@ -108,7 +127,7 @@ async function main() {
     // return;
     // other commands
     let command = process.argv[2];
-    if (!["init", "prod", "test", "scp", "scpevt", "pipeline", "offlinepkgrm", "rollback"].includes(command)) {
+    if (!["init", "prod", "test", "scp", "scpevt", "pipeline", "offlinepkgrm"].includes(command)) {
         command = "help";
     }
 
@@ -118,7 +137,6 @@ async function main() {
         console.log(`command: init [-c {configFileName}] 初始化配置`);
         console.log(`command: prod [-c {configFileName}] 生产环境部署`);
         console.log(`command: test 测试环境部署`);
-        console.log(`command: rollback {prod|test} {tag} 回滚到指定tag, 注意不处理离线包`);
         console.log(`command: scp {file} 复制文件{file}到OfficialSite测试服务器{file}`);
         console.log(`command: scp {file} {dest} 复制文件{file}到OfficialSite测试服务器{dest}`);
         console.log(`command: scpevt {file} 复制文件{file}到events测试服务器{file}`);
@@ -129,12 +147,6 @@ async function main() {
     }
     log(`deploy-helper v${version} start`);
 
-    const workDir = process.cwd(); // 当前项目根目录
-    let mode = '';
-    let configFileName = '';
-    let isDoRollback = false;
-    let rollbackCleanFunc = null;
-
     // 其他命令
     if (command === "init") {
         await initConfigJson();
@@ -145,6 +157,7 @@ async function main() {
             log(`file参数不能为空`);
             process.exit(1);
         }
+        const workDir = process.cwd(); // 当前项目根目录
 
         const srcFilePath = join(workDir, file);
         if (!fs.existsSync(srcFilePath)) {
@@ -214,29 +227,13 @@ async function main() {
         }
         await syncOfflinePkgApi(userDeployHelperConfig, mode, { name, remove: true, platform }, null);
         process.exit(0);
-    } else if(command === "rollback") {
-        // 回滚
-        mode = process.argv[3] === 'prod' ? 'prod' : 'test'; // 部署环境
-        if(!['prod', 'test'].includes(mode)){
-            log(`mode参数只能是prod或test`);
-            process.exit(1);
-        }
-        let tag = process.argv[4];
-        if(!tag){
-            tag = await tagRelease.getTag(workDir, mode);
-            if(!tag){
-                log(`未找到tag`);
-                process.exit(1);
-            }
-        }
-        // 做好回滚操作
-        rollbackCleanFunc = await tagRelease.rollback(workDir, tag);
-        isDoRollback = true;
-    } else {
-        // 部署
-        mode = process.argv[2] === 'prod' ? 'prod' : 'test'; // 部署环境
+    }
+    try {
+        const workDir = process.cwd(); // 当前项目根目录
+        const mode = process.argv[2] === 'prod' ? 'prod' : 'test'; // 部署环境
         log(`deploy mode: ${mode}`);
         log(`workDir: ${workDir}`);
+        let configFileName = '';
         if(process.argv[3] === '-c'){
             // 尝试从-c中获取配置文件名
             configFileName = process.argv[4];
@@ -247,8 +244,6 @@ async function main() {
                 log(`将使用配置文件: ${configFileName}`);
             }
         }
-    }
-    try {
         // 读取配置
         const config = await loadConfig(configFileName);
         if(!config){
@@ -262,15 +257,8 @@ async function main() {
             process.exit(1);
         }
 
-        if(!isDoRollback){ // 正常部署的时候，才会处理打tag操作
-            const canDoTag = await tagRelease.check(workDir, config, mode);
-            if(canDoTag){
-                await tagRelease.createRelease(workDir,config, mode);
-            }
-        }
 
-        // rollback的时候，只处理entry文件的回滚操作，assets文件不处理
-        const needHandleAssets = !isDoRollback && config.assets && config.assets.dest;
+        const needHandleAssets = config.assets && config.assets.dest;
 
         // 需要处理entry
         const needHandleEntry = config.entry && config.entry.dest && (mode === 'prod' || (mode === 'test' && !config.entry.onlyProd));
@@ -285,7 +273,6 @@ async function main() {
         const offlinePkgResult = checkOfflinePkg({
             workDir: workDir,
             mode,
-            isDoRollback,
         });
         if (!offlinePkgResult.canBuild && offlinePkgResult.errorMsg) {
             log(`${offlinePkgResult.errorMsg}`);
@@ -493,29 +480,18 @@ async function main() {
             }
         } catch (error) {
             log(`scp error: ${error}`);
-            // log(`复制文件到测试环境服务器失败, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
-            // if (assetsFilesCount > 0) {
-            //     log(`不过请放心，构建产物的assets已经处理完成，只要手动处理index.html文件即可。`);
-            // }
+            log(`复制文件到测试环境服务器失败, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
+            if (assetsFilesCount > 0) {
+                log(`不过请放心，构建产物的assets已经处理完成，只要手动处理index.html文件即可。`);
+            }
             process.exit(1);
         }
 
-        if(isDoRollback && rollbackCleanFunc){
-            await rollbackCleanFunc();
-        }
 
-        try {
-            // 处理触发流水线的任务
-            await runPipeline(config, mode);
-        } catch (error) {
-            log(`触发流水线失败: `, error);
-        }
+        // 处理触发流水线的任务
+        await runPipeline(config, mode);
 
-        if(isDoRollback){
-            log(`deploy-helper rollback done.`);
-        } else {
-            log(`deploy-helper deploy done.`);
-        }
+        log(`deploy-helper deploy done.`);
         process.exit(0);
 
     } catch (error) {

package/lib/offlinePkg.mjs

@@ -154,17 +154,9 @@ if(item.attrs.id=='vite-legacy-polyfill')childNode.onload=function(){System.impo
  * @param {Object} config 配置
  * @param {string} config.workDir 工作目录
  * @param {"prod"|"test"} config.mode 部署模式
- * @param {boolean} config.isDoRollback 是否是回滚操作
  * @returns {CheckOfflinePkgResult} 结果
  */
 export function checkOfflinePkg(config) {
-    if(config.isDoRollback){
-        log(`【注意】回滚操作，不处理离线包`);
-        return {
-            canBuild: false,
-            errorMsg: "",
-        }
-    }
     let canBuildOfflinePkg = true;
     let errorMsg = "";
     const offlineConfig = getJsonConfig(config.workDir, "offline.config.json");

package/lib/pipelineApi.mjs

@@ -355,7 +355,6 @@ export async function runPipeline(config, mode) {
     const token = getYunxiaoToken(pipelineConfig);
     if (!token) {
         log(`未设置云效token, 此次流水线未自动执行: ${JSON.stringify(pipelineConfig)}`);
-        return;
     }
     process.env.YUNXIAO_ACCESS_TOKEN = token;
 

package/lib/util.mjs

@@ -1,49 +1,46 @@
-import fs from "fs";
-import { join } from "node:path";
-import { homedir } from "node:os";
-import { Client } from "node-scp";
+import fs from 'fs';
+import { join } from "node:path"
+import { homedir } from "node:os"
 
 let _isDebug = false;
 export function setDebug(debug) {
-  _isDebug = debug;
+    _isDebug = debug;
 }
 
 export function isDebug() {
-  return _isDebug;
+    return _isDebug;
 }
 
 export function log(...args) {
-  if (_isDebug) {
-    // 打印时间
-    console.log(`[${new Date().toLocaleTimeString()}]`, ...args);
-  } else {
-    console.log(...args);
-  }
+    if (_isDebug) {
+        // 打印时间 
+        console.log(`[${new Date().toLocaleTimeString()}]`, ...args);
+    } else {
+        console.log(...args);
+    }
 }
 
 export function getOssToken() {
-  let token = "";
-  token = process.env.TW_DH_OSS_TOKEN || "";
-  if (token) {
-    log(`将使用来自环境变量TW_DH_OSS_TOKEN的token`);
-    return token;
-  }
-  const userDeployHelperDir = join(homedir(), "deploy-helper.config.json");
-  if (fs.existsSync(userDeployHelperDir)) {
-    try {
-      const userDeployHelperConfig = JSON.parse(
-        fs.readFileSync(userDeployHelperDir, "utf-8")
-      );
-      token = userDeployHelperConfig.ossToken || "";
-    } catch (error) {
-      console.error(`读取${userDeployHelperDir}配置失败: ${error}`);
-    }
+    let token = "";
+    token = process.env.TW_DH_OSS_TOKEN || ""
     if (token) {
-      log(`将使用来自${userDeployHelperDir}的ossToken`);
-      return token;
+        log(`将使用来自环境变量TW_DH_OSS_TOKEN的token`);
+        return token;
+    }
+    const userDeployHelperDir = join(homedir(), "deploy-helper.config.json");
+    if (fs.existsSync(userDeployHelperDir)) {
+        try {
+            const userDeployHelperConfig = JSON.parse(fs.readFileSync(userDeployHelperDir, "utf-8"));
+            token = userDeployHelperConfig.ossToken || "";
+        } catch (error) {
+            console.error(`读取${userDeployHelperDir}配置失败: ${error}`);
+        }
+        if (token) {
+            log(`将使用来自${userDeployHelperDir}的ossToken`);
+            return token;
+        }
     }
-  }
-  return token;
+    return token;
 }
 
 /**
@@ -51,36 +48,14 @@ export function getOssToken() {
  * @returns {Object|null} 用户配置
  */
 export function getUserDeployHelperConfig() {
-  const userDeployHelperDir = join(homedir(), "deploy-helper.config.json");
-  if (fs.existsSync(userDeployHelperDir)) {
-    try {
-      const userDeployHelperConfig = JSON.parse(
-        fs.readFileSync(userDeployHelperDir, "utf-8")
-      );
-      return userDeployHelperConfig;
-    } catch (error) {
-      console.error(`读取${userDeployHelperDir}配置失败: ${error}`);
+    const userDeployHelperDir = join(homedir(), "deploy-helper.config.json");
+    if (fs.existsSync(userDeployHelperDir)) {
+        try {
+            const userDeployHelperConfig = JSON.parse(fs.readFileSync(userDeployHelperDir, "utf-8"));
+            return userDeployHelperConfig;
+        } catch (error) {
+            console.error(`读取${userDeployHelperDir}配置失败: ${error}`);
+        }
     }
-  }
-  return null;
-}
-
-export const TEST_SERVER_HOST = "192.168.0.35";
-export async function getScpClient() {
-  let scpClient = null;
-  // 不能放密码。。残念
-  const scpClientConfig = {
-    host: TEST_SERVER_HOST,
-    username: "root",
-    tryKeyboard: false,
-    password: "tuwan123!@#",
-  };
-  // const sshKeyPath = join(homedir(), ".ssh/id_rsa");
-  // if (fs.existsSync(sshKeyPath)) {
-  //     scpClientConfig.privateKey = fs.readFileSync(sshKeyPath, "utf-8");
-  // } else {
-  //     log(`${sshKeyPath}不存在, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
-  // }
-  scpClient = await Client(scpClientConfig);
-  return scpClient;
-}
+    return null;
+}

package/modules/alibabacloud-devops-mcp-server/dist/operations/flow/pipeline.js

@@ -52,7 +52,7 @@ export async function listPipelinesFunc(organizationId, options) {
         queryParams.page = options.page;
     }
     const url = utils.buildUrl(baseUrl, queryParams);
-    const response = await utils.yunxiaoRequest(url, {
+    let response = await utils.yunxiaoRequest(url, {
         method: "GET",
     });
     const pagination = {
@@ -65,6 +65,13 @@ export async function listPipelinesFunc(organizationId, options) {
     };
     let items = [];
     if (Array.isArray(response)) {
+        response = response.map((item) => ({
+            ...item,
+            id: item.id || item.pipelineId,
+            name: item.name || item.pipelineName,
+            creatorAccountId: item.creatorAccountId || item.createAccountId,
+            createTime: item.createTime || item.createTime,
+        }))
         items = response.map(item => PipelineListItemSchema.parse(item));
     }
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taole/deploy-helper",
-  "version": "0.7.4-beta.6",
+  "version": "0.7.5",
   "description": "脚本部署工具，用于将项目部署到测试环境或生产环境",
   "main": "index.mjs",
   "type": "module",
@@ -24,9 +24,8 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@inquirer/rawlist": "^5.2.0",
-    "ali-oss": "^6.23.0",
     "alibabacloud-devops-mcp-server": "*",
+    "ali-oss": "^6.23.0",
     "archiver": "^7.0.1",
     "md5-file": "^5.0.0",
     "node-scp": "^0.0.25",

package/lib/tagRelease.mjs

@@ -1,254 +0,0 @@
-// 处理项目发布时的构建产物问题
-
-import { log } from "./util.mjs";
-import path from "path";
-import fs from "fs";
-import simpleGit from "simple-git";
-import rawlist from "@inquirer/rawlist";
-
-async function getTag(workDir, mode) {
-  const packageJson = JSON.parse(
-    fs.readFileSync(path.join(workDir, "package.json"), "utf-8")
-  );
-  const prefix = getTagNamePrefix(packageJson, mode);
-  const git = simpleGit(workDir);
-  let tags = await git.tags(["-n", "--sort=-creatordate"]); // 按照创建时间排序，最新的在前
-  // console.log(`tags: ${JSON.stringify(tags)}`);
-  tags = tags.all
-    .filter((tag) => tag.startsWith(prefix))
-    .slice(0, 15) // 最多显示15个tag
-    .map((tag) => {
-      // tag是一个字符串， 从左到右找到第一个空格， 这个空格以前的内容就是tag的名称， 以后的如有， 取出来当作commit信息，并考虑tag无空格的情况
-      const spaceIndex = tag.indexOf(" ");
-      let commitInfo = "";
-      let tagName = tag;
-      if (spaceIndex !== -1) {
-        commitInfo = (tag.slice(spaceIndex + 1) || "").trim();
-        tagName = tag.slice(0, spaceIndex);
-      }
-      return {
-        name: tagName,
-        commitInfo: commitInfo,
-        rawTag: tag,
-      };
-    });
-  // console.log(`formated tags: ${JSON.stringify(tags)}`);
-  let tag = null;
-  if (tags.length > 0) {
-    const propmtConfig = {
-      message: "请选择要回滚的tag版本: ",
-      choices: tags.map((item) => ({
-        name: item.rawTag,
-        value: item.name,
-      })),
-    };
-    try {
-      tag = await rawlist(propmtConfig);
-    } catch (error) {
-      log(`选择获取tag失败`);
-    }
-  }
-  if (tag) {
-    log(`已选择tag: ${tag}`);
-  }
-  return tag;
-}
-
-// 前置条件，项目当前是干净的，没有未提交的修改
-
-function getTagNamePrefix(packageJson, mode) {
-  return `release_${mode}_${packageJson.name}`;
-}
-
-function getTagName(packageJson, commitId, mode) {
-  const prefix = getTagNamePrefix(packageJson, mode);
-  let tagName = prefix;
-  const date = new Date();
-  const timeStr =
-    date.getFullYear() +
-    "-" +
-    date.getMonth() +
-    1 +
-    "-" +
-    date.getDate() +
-    "-" +
-    date.getHours() +
-    "-" +
-    date.getMinutes() +
-    "-" +
-    date.getSeconds();
-  // tagName += `@${packageJson.version}`;
-  tagName += `_${commitId.slice(0, 8)}`;
-  tagName += `_${timeStr}`;
-  return tagName;
-}
-
-/**
- * 检查是否需要打tag
- * @param {*} config 配置对象
- * @returns 是否需要打tag
- */
-async function check(workDir, config, mode) {
-  const tagConfig = config.tag;
-  if (!tagConfig) {
-    return false;
-  }
-  let needTag = false;
-  if (tagConfig.test && mode === "test") {
-    needTag = true;
-  }
-  if (tagConfig.prod && mode === "prod") {
-    needTag = true;
-  }
-  const skipCleanCheck = false;
-  if (needTag && !skipCleanCheck) {
-    // 检查当前仓库是否干净
-    const git = simpleGit(workDir);
-    const status = await git.status();
-    if (!status.isClean()) {
-      log(`【tag】当前仓库有未提交的修改，请先提交`);
-      process.exit(1);
-    }
-  }
-  return needTag;
-}
-/**
- * 回滚到指定tag
- * @param {string} workDir 工作目录
- * @param {string} mode 部署模式
- * @param {string} tag 要回滚的tag
- * @returns Promise<function> 回滚后需要执行的清理函数
- */
-async function rollback(workDir, tag) {
-  const git = simpleGit(workDir);
-  const commitId = await git.revparse("HEAD");
-  const branchInfo = await git.branch();
-  const status = await git.status();
-  if (!status.isClean()) {
-    log(`【rollback】回滚前请确保当前仓库是干净的`);
-    process.exit(1);
-  }
-  // log("回滚前状态:");
-  log(`branch: ${branchInfo.current}`);
-  log(`commitId: ${commitId}`);
-  const cleanfunc = async () => {
-    await git.reset(["--hard", commitId]);
-    await git.checkout(branchInfo.current);
-  };
-  try {
-    await git.checkout(tag);
-    const releaseDir = path.join(process.cwd(), ".taole_release");
-    if (!fs.existsSync(releaseDir)) {
-      log(`【rollback】.taole_release目录不存在，无法回滚`);
-      await cleanfunc();
-      process.exit(1);
-    }
-    const config = JSON.parse(
-      fs.readFileSync(path.join(releaseDir, "deploy.config.json"), "utf-8")
-    );
-    const entryFiles = config.entry.files;
-    Object.keys(entryFiles).forEach((key) => {
-      const src = `_${key}`;
-      const dest = key;
-      log(`rollback file: ${dest}`);
-      fs.cpSync(path.join(releaseDir, src), path.join(workDir, dest), {
-        recursive: true,
-      });
-    });
-    fs.cpSync(
-      path.join(releaseDir, "deploy.config.json"),
-      path.join(workDir, "deploy.config.json"),
-      {
-        recursive: true,
-        force: true,
-      }
-    );
-    log(`rollback file: deploy.config.json`);
-    log(`ready to re-deploy`);
-  } catch (error) {
-    await cleanfunc();
-    log(`【rollback】回滚失败: ${error}`);
-    process.exit(1);
-  }
-  return cleanfunc;
-}
-
-/**
- * 创建tag记录，用于后续的回退
- * @param {*} config
- */
-async function createRelease(workDir, config, mode) {
-  // 操作步骤：
-  // 0. 记录当前git的commit id, 记为commitId
-  // 1. 在项目目录检查是否有.taole_release目录，有则删除然后新建
-  // 2. 将配置中entry.files定义的后缀为html的文件复制到.taole_release目录下
-  // 3. 提交.taole_release目录到git，commmit 信息为 -#DH-2 整理构建产物
-  // 4. 打tag，tag名称为 v{package.json的version}.{commitId}.{yyyy_mm_dd_HH_MM}, 并推到远程仓库
-  // 5. 回退当前git的commit id到commitId
-
-  const git = simpleGit(workDir);
-  const commitId = await git.revparse("HEAD");
-  const commitMessage = (
-    await git.raw(["log", "-1", "--format=%s", commitId])
-  ).trim();
-
-  log(`commitId: ${commitId}`);
-
-  const cleanfunc = async () => {
-    await git.reset(["--hard", commitId]);
-  };
-
-  try {
-    // 1. 在项目目录检查是否有.taole_release目录，有则删除然后新建
-    const releaseDir = path.join(process.cwd(), ".taole_release");
-    if (fs.existsSync(releaseDir)) {
-      fs.rmSync(releaseDir, { recursive: true });
-    }
-    fs.mkdirSync(releaseDir);
-
-    // 2. 将配置中entry.files定义的后缀为html的文件涉及的所有html文件复制到.taole_release目录下
-    const entryFiles = config.entry.files;
-    Object.keys(entryFiles).forEach((key) => {
-      const file = key;
-      const htmlFilePath = path.join(workDir, file);
-      // log(`htmlFilePath: ${htmlFilePath}`);
-      if (fs.existsSync(htmlFilePath)) {
-        const destFile = `_${file}`;
-        fs.cpSync(htmlFilePath, path.join(releaseDir, destFile), {
-          recursive: true,
-        });
-      }
-    });
-    // 2.1 将当前的config也写入.taole_release目录下
-    fs.writeFileSync(
-      path.join(releaseDir, "deploy.config.json"),
-      JSON.stringify(config, null, 2)
-    );
-
-    await git.add(releaseDir);
-    // await git.commit("-#DH-2 --> ${commitMessage}");
-    await git.commit(commitMessage || `-#DH-2 ${commitId.slice(0, 8)}`);
-    // log(`commitResult: ${JSON.stringify(commitResult)}`);
-
-    const packageJson = JSON.parse(
-      fs.readFileSync(path.join(workDir, "package.json"), "utf-8")
-    );
-    const tagName = getTagName(packageJson, commitId, mode);
-    // log(`tagName: ${tagName}`);
-    await git.tag([tagName]);
-    await git.push("origin", tagName);
-    log(`打tag成功: ${tagName}, 可用于后续回滚`);
-    await cleanfunc();
-  } catch (error) {
-    log(`创建tag记录失败: ${error}`);
-    await cleanfunc();
-    process.exit(1);
-  }
-}
-
-export default {
-  getTag,
-  check,
-  createRelease,
-  rollback,
-};