@taole/deploy-helper 0.4.1 → 0.5.0

package/index.mjs

@@ -109,11 +109,11 @@ 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}`);
-        console.log(`command: pipeline {pipelineName|pipelineId} 触发流水线{pipelineName|pipelineId}`);
+        console.log(`command: pipeline {pipelineName|pipelineId} [branch] 触发流水线{pipelineName|pipelineId}， 指定分支(可省略)`);
         process.exit(0);
     }
     log("deploy-helper start");
-    
+
     // 其他命令
     if (command === "init") {
         await initConfigJson();
@@ -162,11 +162,12 @@ async function main() {
             log(`pipeline参数不能为空`);
             process.exit(1);
         }
+        const branch = process.argv[4] || "";
         try {
-            await triggerPipeline(pipelineName, true);
+            await triggerPipeline(pipelineName, { waitResult: true, branch });
             process.exit(0);
         } catch (error) {
-            log(`触发流水线失败: ${error}`);
+            log(`触发流水线失败: `, error);
             process.exit(1);
         }
 
@@ -181,12 +182,6 @@ async function main() {
         const config = await loadConfig();
         // log(`config`, config);
 
-        // 检查配置格式
-        if (!config.assets || !config.assets.dest || !config.entry || !config.entry.dest) {
-            log(`配置格式错误, 请检查deploy.config.js或deploy.config.json`);
-            return;
-        }
-
         const result = hasChangeMe(JSON.stringify(config));
         if (result) {
             log(`配置中存在默认值(CHANGE_ME), 请先修改配置`);
@@ -194,8 +189,10 @@ async function main() {
         }
 
 
+        const needHandleAssets = config.assets && config.assets.dest;
+
         // 需要处理entry
-        const needHandleEntry = mode === 'prod' || (mode === 'test' && !config.entry.onlyProd);
+        const needHandleEntry = config.entry && config.entry.dest && (mode === 'prod' || (mode === 'test' && !config.entry.onlyProd));
         const entryTestBranch = (config.entry && config.entry.testBranch) || "test";
         const entryProdBranch = (config.entry && config.entry.prodBranch) || "master";
         const entryTargetBranch = mode === 'prod' ? entryProdBranch : entryTestBranch;
@@ -208,24 +205,34 @@ async function main() {
 
         // 检查项目
         // 1. 检查项目是否存在
-        const assetsDest = join(workDir, config.assets.dest);
-        const entryDest = join(workDir, config.entry.dest);
-        if (!fs.existsSync(assetsDest)) {
-            log(`assets.dest路径不存在: ${assetsDest}, 请先创建`);
-            return;
+        let assetsDest = null;
+        let entryDest = null;
+        if (needHandleAssets) {
+            assetsDest = join(workDir, config.assets.dest);
+            if (!fs.existsSync(assetsDest)) {
+                log(`assets.dest路径不存在: ${assetsDest}, 请先创建`);
+                process.exit(1);
+            }
         }
         // entry.dest
-        if (needHandleEntry && !fs.existsSync(entryDest)) {
-            log(`entry.dest路径不存在: ${entryDest}, 请先创建`);
-            return;
+        if (needHandleEntry) {
+            entryDest = join(workDir, config.entry.dest);
+            if (!fs.existsSync(entryDest)) {
+                log(`entry.dest路径不存在: ${entryDest}, 请先创建`);
+                process.exit(1);
+            }
         }
 
         // 2. 检查项目是否clean
-        const assetsGit = simpleGit(assetsDest);
-        let assetsStatus = await assetsGit.status();
-        if (!assetsStatus.isClean()) {
-            log(`${assetsDest}目前有未提交内容, 请先处理`);
-            return;
+        let assetsGit = null;
+        let assetsStatus = null;
+        if (needHandleAssets) {
+            assetsGit = simpleGit(assetsDest);
+            assetsStatus = await assetsGit.status();
+            if (!assetsStatus.isClean()) {
+                log(`${assetsDest}目前有未提交内容, 请先处理`);
+                return;
+            }
         }
 
         let entryGit;
@@ -255,7 +262,7 @@ async function main() {
 
         // 3. 检查assets项目分支，并切换至master分支
         // assets项目固定使用master分支
-        if (assetsStatus.current !== "master") {
+        if (needHandleAssets && assetsStatus.current !== "master") {
             log(`${assetsDest}当前分支不是master, 切换至master分支`);
             await assetsGit.checkout("master");
             log(`${assetsDest}切换至master分支成功`);
@@ -267,9 +274,11 @@ async function main() {
         }
 
         // 4. 执行git pull
-        log(`${assetsDest}执行git pull`);
-        await assetsGit.pull();
-        log(`${assetsDest} git pull done`);
+        if (assetsGit) {
+            log(`${assetsDest}执行git pull`);
+            await assetsGit.pull();
+            log(`${assetsDest} git pull done`);
+        }
         if (entryGit) {
             log(`${entryDest}执行git pull`);
             await entryGit.pull();
@@ -278,24 +287,26 @@ async function main() {
 
         // 5. 复制构建产物
         // 5.1 复制assets
-        let assetsFilesCount = 0;
-        const assetsFiles = config.assets.files;
-        for (const [src, dest] of Object.entries(assetsFiles)) {
-            const srcPath = join(workDir, src);
-            if (!fs.existsSync(srcPath)) {
-                log(`${srcPath}不存在，请确认构建产物是否正确`);
-                return;
-            }
-            const destPath = join(assetsDest, dest);
-            if (fs.statSync(srcPath).isDirectory()) {
-                fs.cpSync(srcPath, destPath, { recursive: true });
-            } else {
-                fs.copyFileSync(srcPath, destPath);
+        if (needHandleAssets) {
+            let assetsFilesCount = 0;
+            const assetsFiles = config.assets.files;
+            for (const [src, dest] of Object.entries(assetsFiles)) {
+                const srcPath = join(workDir, src);
+                if (!fs.existsSync(srcPath)) {
+                    log(`${srcPath}不存在，请确认构建产物是否正确`);
+                    return;
+                }
+                const destPath = join(assetsDest, dest);
+                if (fs.statSync(srcPath).isDirectory()) {
+                    fs.cpSync(srcPath, destPath, { recursive: true });
+                } else {
+                    fs.copyFileSync(srcPath, destPath);
+                }
+                log(`assets copy: ${srcPath} -> ${destPath}`);
+                assetsFilesCount++;
             }
-            log(`assets copy: ${srcPath} -> ${destPath}`);
-            assetsFilesCount++;
+            // log(`assets copy done.`);
         }
-        // log(`assets copy done.`);
         // 5.2 复制entry
         if (needHandleEntry) {
             const entryFiles = config.entry.files;
@@ -319,18 +330,19 @@ async function main() {
         // 6. 提交
         let canPushAssets = false;
         let canPushEntry = false;
-        assetsStatus = await assetsGit.status();
-        if (!assetsStatus.isClean()) {
-            canPushAssets = true;
-            await assetsGit.add(".");
-            const assetsCommit = `${config.assets.commit || "feat:部署资源文件"} by deploy-helper`;
-            const assetsCommitResult = await assetsGit.commit(assetsCommit);
-            log(`assets commit: ${assetsCommit}`);
-            log(`assets commit: ${JSON.stringify(assetsCommitResult.summary)}`);
-        } else {
-            log(`${assetsDest} 未发现修改内容,跳过提交`);
+        if (needHandleAssets) {
+            assetsStatus = await assetsGit.status();
+            if (!assetsStatus.isClean()) {
+                canPushAssets = true;
+                await assetsGit.add(".");
+                const assetsCommit = `${config.assets.commit || "feat:部署资源文件"} by deploy-helper`;
+                const assetsCommitResult = await assetsGit.commit(assetsCommit);
+                log(`assets commit: ${assetsCommit}`);
+                log(`assets commit: ${JSON.stringify(assetsCommitResult.summary)}`);
+            } else {
+                log(`${assetsDest} 未发现修改内容,跳过提交`);
+            }
         }
-
         if (needHandleEntry) {
             entryStatus = await entryGit.status();
             if (!entryStatus.isClean()) {

package/lib/pipelineApi.mjs

@@ -26,27 +26,27 @@ function getCurrentJob(runDetail) {
     const stages = runDetail.stages;
 
     // 找到当前阶段
-    for(let i = 0; i < stages.length; i++) {
+    for (let i = 0; i < stages.length; i++) {
         const stage = stages[i];
         currentStage = stage;
         const stageStatus = stage.stageInfo.status;
-        if(stageStatus === "RUNNING" || stageStatus === "WAITING" || stageStatus === "FAIL") {
+        if (stageStatus === "INIT" || stageStatus === "RUNNING" || stageStatus === "WAITING" || stageStatus === "FAIL") {
             break;
         }
     }
 
-    if(currentStage) {
+    if (currentStage) {
         const jobs = currentStage.stageInfo.jobs;
-        for(let i = 0; i < jobs.length; i++) {
+        for (let i = 0; i < jobs.length; i++) {
             const job = jobs[i];
             currentJob = job;
             const jobStatus = job.status;
-            if(jobStatus === "RUNNING" || jobStatus === "WAITING" || jobStatus === "FAIL") {
+            if (jobStatus === "INIT" || jobStatus === "RUNNING" || jobStatus === "WAITING" || jobStatus === "FAIL") {
                 break;
             }
         }
     }
-    return {stage: currentStage, job: currentJob};
+    return { stage: currentStage, job: currentJob };
 }
 
 /**
@@ -161,7 +161,7 @@ async function waitPipelineRunFinish(pipelineID, runId, interval = 5000) {
     let runDetail = await getPipelineRunFunc(organizationId, pipelineID, runId);
     let passFailedCount = 0;
     let passFailedMaxCount = 3;
-    while (runDetail.status === "RUNNING" || runDetail.status === "WAITING") {
+    while (runDetail.status === "RUNNING" || runDetail.status === "WAITING" || runDetail.status === "INIT") {
         const { stage, job } = getCurrentJob(runDetail);
         log(`流水线执行状态: ${runDetail.status}，阶段: ${stage.name}，任务: ${job.name}，等${interval / 1000}秒后重新轮询`);
         if (runDetail.status === "WAITING") {
@@ -179,9 +179,8 @@ async function waitPipelineRunFinish(pipelineID, runId, interval = 5000) {
                     passFailedCount++;
                     log(`人工卡点通过失败`, error);
                 }
-                
             }
-            if(passFailedCount >= passFailedMaxCount) {
+            if (passFailedCount >= passFailedMaxCount) {
                 log(`人工卡点通过失败次数超过最大值， 放弃`);
                 break;
             }
@@ -197,33 +196,78 @@ async function waitPipelineRunFinish(pipelineID, runId, interval = 5000) {
     return runDetail;
 }
 
+/**
+ * 获取流水线信息和源码仓库信息, 不指定分支则不返回源码仓库信息
+ * @param {*} pipelineName 流水线名称或id
+ * @param {*} targetBranch 指定分支， 如果为空，则不指定分支
+ * @returns 流水线信息和源码仓库信息, 触发流水线参数
+ */
+async function getPipelineInfoDetail(pipelineName, targetBranch = ""){
+    let pipelineID = "";
+    let pipelineInfo = null;
+    let repoInfo = null;
+    let hasDetail = false;
+    if (/^\d+$/.test(pipelineName)) {
+        pipelineID = pipelineName;
+        pipelineInfo = await getPipelineFunc(organizationId, pipelineID);
+        pipelineInfo.id = pipelineID;
+        hasDetail = true;
+    } else {
+        const info = await getPipelineInfoByName(pipelineName);
+        pipelineInfo = info;
+        pipelineID = info.id;
+        hasDetail = false;
+    }
+    // 如果需要指定分支，则需要获取源码仓库信息
+    if (targetBranch) {
+        if (!hasDetail) {
+            pipelineInfo = await getPipelineFunc(organizationId, pipelineID);
+            pipelineInfo.id = pipelineID;
+        }
+        if (pipelineInfo && pipelineInfo.pipelineConfig && Array.isArray(pipelineInfo.pipelineConfig.sources)) {
+            repoInfo = pipelineInfo.pipelineConfig.sources[0];
+        }
+    }
+
+    if (targetBranch && !repoInfo) {
+        throw new Error(`未找到源码仓库信息，请检查流水线配置是否正确`);
+    }
+    const params = {
+        "envs": {
+            "Change_Log": "deploy-helper触发", // 此处不可以带空格，否则会报错
+        },
+        "needCreateBranch": false,
+        "comment": "triggered by deploy-helper"
+    }
+    if (targetBranch && repoInfo) {
+        params.runningBranchs = {
+            [`${repoInfo.data.repo}`]: targetBranch
+        }
+        log(`指定分支: ${targetBranch}， 源码仓库: ${repoInfo.data.repo}`);
+    }
+    const runParams = {
+        params: JSON.stringify(params)
+    };
+    return { pipelineInfo, repoInfo, runParams };
+}
 
 /**
  * 触发流水线
  * @param {*} pipelineName 流水线名称或id
  * @param {*} waitResult 是否等待流水线执行完成
  */
-export async function triggerPipeline(pipelineName, waitResult = false) {
+export async function triggerPipeline(pipelineName, opts = {}) {
+    const { waitResult = false } = opts;
     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}`);
+    const { pipelineInfo, runParams } = await getPipelineInfoDetail(pipelineName, opts.branch);
+    const runId = await createPipelineRunFunc(organizationId, pipelineInfo.id, runParams);
+    const pipelineRunDetailUrl = `https://flow.aliyun.com/pipelines/${pipelineInfo.id}/builds/${runId}`;
+    log(`流水线${pipelineInfo.name}[${pipelineInfo.id}]触发成功，流水线执行id: ${runId}， 流水线执行详情: ${pipelineRunDetailUrl}`);
     if (waitResult) {
-        await waitPipelineRunFinish(pipelineID, runId);
+        await waitPipelineRunFinish(pipelineInfo.id, runId);
     }
 }
 
@@ -261,15 +305,10 @@ export function checkYunxiaoToken(config, mode) {
 
 async function runSinglePipeline(pipeline, index, total) {
     log(`开始处理流水线: ${pipeline.name}， 当前是第${index + 1}个， 总共${total}个`);
-    let pipelineId = pipeline.id || "";
-    if (!pipelineId) {
-        // 获取流水线信息
-        const pipelineInfo = await getPipelineInfoByName(pipeline.name);
-        pipelineId = pipelineInfo.id;
-    }
-    log(`流水线${pipeline.name}的id: ${pipelineId}`);
+    const { pipelineInfo, runParams } = await getPipelineInfoDetail(pipeline.id || pipeline.name, pipeline.branch);
 
     // 处理分支强推的问题
+    // 将要废弃force2Branch这个配置
     const force2Branch = pipeline.force2Branch;
     if (force2Branch && force2Branch.src && force2Branch.dest) {
         let repo = pipeline.repo || "./";
@@ -296,13 +335,11 @@ async function runSinglePipeline(pipeline, index, total) {
         await git.raw("push", "origin", `${force2Branch.src}:${force2Branch.dest}`, "--force");
         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}`;
-    log(`流水线${pipeline.name}触发成功，流水线执行id: ${runId}， 流水线执行详情: ${piplineRunDetailUrl}`);
-    if(pipeline.waitResult) {
-        await waitPipelineRunFinish(pipelineId, runId);
+    const runId = await createPipelineRunFunc(organizationId, pipelineInfo.id, runParams);
+    const piplineRunDetailUrl = `https://flow.aliyun.com/pipelines/${pipelineInfo.id}/builds/${runId}`;
+    log(`流水线${pipelineInfo.name}触发成功，流水线执行id: ${runId}， 流水线执行详情: ${piplineRunDetailUrl}`);
+    if (pipeline.waitResult) {
+        await waitPipelineRunFinish(pipelineInfo.id, runId);
     }
 }
 

package/package.json

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