upload-miniprogram 0.0.23 → 1.0.0

package/README.md

@@ -29,28 +29,26 @@ npm install --save-dev upload-miniprogram
 
 ```bash
 # 基本用法
-upload-miniprogram --appid your-appid --project-path ./dist --version 1.0.0
+upload-miniprogram --appid your-appid --project-path ./dist --app-version V0.0.1 --env development --desc "功能更新"
 
 # 完整参数
 upload-miniprogram \
   --appid your-appid \
   --project-path ./dist \
-  --version 1.0.0 \
-  --desc "功能更新" \
-  --user developer@example.com \
-  --env production
+  --env development \
+  --app-version V0.0.1 \
+  --desc "功能更新" 
 ```
 
 ### 参数说明
 
-| 参数 | 缩写 | 必填 | 说明 |
-|------|------|------|------|
-| --appid | -a | 是 | 小程序ID |
-| --project-path | -p | 是 | 小程序项目打包后的代码路径 |
-| --version | -v | 是 | 版本号 |
-| --desc | -d | 否 | 版本描述 |
-| --user | -u | 否 | 上传用户 |
-| --env | -e | 否 | 环境变量 (development\|staging\|uat\|production) |
+| 参数 | 缩写 | 必填 | 说明 | 参数修改说明|
+|------|------|------|------|------|
+| --appid | -a | 是 | 小程序ID |每个项目固定1-2个，可能跟环境不同，确定后不需再修改|
+| --project-path | -p | 是 | 小程序项目打包后的代码路径 |一般是 ./dist 或 ./dist/weapp 每个项目固定1个路径，确定后不需再修改|
+| --env | -e | 否 | 环境变量 (development\|staging\|uat\|production) | 按每个Jerkins链接的环境设置|
+| --app-version | -V | 是 | 上传至小程序的版本号 |每次构建时需要重新填写|
+| --desc | -d | 否 | 版本描述 |每次构建时需要重新填写|
 
 ### 编程方式
 
@@ -106,6 +104,7 @@ ${WORKSPACE}/../mp-ci-upload-key/private.{appid}.key
 
 
 
+
 ## 许可证
 
 MIT

package/bin/upload-miniprogram.js

@@ -21,11 +21,14 @@ console.log('options', options);
 if (options.env) {
   process.env.NODE_ENV = options.env;
 }
-
-uploadMiniprogram({
-  appid: options.appid,
-  projectPath: options.projectPath,
-  version: options.appVersion,
-  desc: options.desc,
-  user: options.user
-});
+if (options.appVersion &&  options.appid && options.projectPath && options.env) {
+  uploadMiniprogram({
+    appid: options.appid,
+    projectPath: options.projectPath,
+    version: options.appVersion,
+    desc: options.desc,
+    user: options.user
+  });
+} else {
+  console.error("执行失败: 缺少必要参数 appid, project-path(projectPath), app-version(appVersion), env(value in development|staging|uat|production)");
+}

package/lib/index.js

@@ -1,6 +1,8 @@
+// https://www.npmjs.com/package/miniprogram-ci
+
 const ci = require("miniprogram-ci");
 const { execSync } = require("child_process");
-const inquirer = require("inquirer");
+// const inquirer = require("inquirer");
 
 class UploadMiniprogram {
   constructor(options = {}) {
@@ -163,7 +165,7 @@ class UploadMiniprogram {
     }
 
     if (questions.length > 0) {
-      const answers = await inquirer.prompt(questions);
+      const answers = []; //await inquirer.prompt(questions); // TODO: 删掉inquir试试
       this.options = { ...this.options, ...answers };
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "upload-miniprogram",
-  "version": "0.0.23",
+  "version": "1.0.0",
   "description": "chatlabs 集成 微信小程序CI/CD上传工具，支持自动上传代码和生成预览二维码",
   "main": "lib/index.js",
   "bin": {
@@ -22,11 +22,10 @@
   "license": "MIT",
   "dependencies": {
     "miniprogram-ci": "^1.9.0",
-    "inquirer": "^8.2.4",
     "commander": "^9.4.1"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=14.8.0"
   },
   "repository": {
     "type": "git",

package/upload-miniprogram.js

@@ -1,191 +0,0 @@
-/* eslint-disable import/no-commonjs */
-// https://www.npmjs.com/package/miniprogram-ci
-
-const ci = require("miniprogram-ci");
-const { execSync } = require("child_process");
-const inquirer = require("inquirer");
-
-const WORKSPACE = process.env.WORKSPACE;
-
-let APP_ID = ""; // 小程序ID
-let PROJECT_PATH = ""; // 小程序项目打包后的代码路径
-
-const PRIVATE_KEY_PATH_JENKINS =
-  "${WORKSPACE}/../mp-ci-upload-key/private.${APP_ID}.key".replace(
-    "${WORKSPACE}",
-    WORKSPACE
-  ); // 小程序私钥路径（需要存在Jerkin服务器，不要存在项目文件里）
-const PREVIEW_CODE_PATH_JENKINS = "${WORKSPACE}/../mp-ci-qrcode-back".replace(
-  "${WORKSPACE}",
-  WORKSPACE
-); // 小程序预览Code的路径
-const PRIVATE_KEY_PATH_LOCAL = "./scripts/private.${APP_ID}.key"; // 小程序私钥路径（需要存在Jerkin服务器，不要存在项目文件里，如不需要本地执行，可以忽略该配置）
-const PREVIEW_CODE_PATH_LOCAL = "./scripts/previewCode"; // 本地预览二维码路径（本地运行命令时才会用到，也要配置本地的IP，如不需要本地执行，可以忽略该配置）
-const PREVIEW_CODE_FILE_NAME = "code.jpg"; // 预览二维码文件名 "code-${version}.jpg"
-
-const ENV = process.env.NODE_ENV;
-const ENV_MAP = {
-  development: { v: ".dev", desc: "【Dev环境】", robot: 1 },
-  staging: { v: ".staging", desc: "【Staging环境】", robot: 2 },
-  uat: { v: ".uat", desc: "【Uat环境】", robot: 3 },
-  production: { v: "", desc: "【正式环境】", robot: 5 },
-};
-
-const env_argv = process.argv;
-console.log("argvs", env_argv);
-
-let v_in_argv, d_in_argv, u_in_argv;
-
-env_argv.forEach((item) => {
-  if (item.includes("version")) {
-    v_in_argv = item.split("=")[1];
-  }
-  if (item.includes("desc")) {
-    d_in_argv = item.split("=")[1];
-  }
-  if (item.includes("user")) {
-    u_in_argv = item.split("=")[1];
-  }
-  if (item.includes("appid")) {
-    APP_ID = item.split("=")[1];
-  }
-  if (item.includes("project-path")) {
-    PROJECT_PATH = item.split("=")[1];
-  }
-});
-
-// 获取 Git 邮箱
-function getGitEmail() {
-  try {
-    return execSync("git config --global user.email", {
-      encoding: "utf8",
-    }).trim();
-  } catch (error) {
-    console.error("无法获取 Git 邮箱:", error.message);
-    return null;
-  }
-}
-
-const executeUploadMPCode = async () => {
-  const gitEmail = getGitEmail();
-  const JerkinsURL = process.env.BUILD_URL ?? "";
-  const isJerkin = Boolean(JerkinsURL);
-
-  const version = `${v_in_argv}${ENV_MAP[ENV].v}`;
-  const desc = `${d_in_argv || ""}`;
-  const fullDesc = `${ENV_MAP[ENV].desc} ${desc} upload by ${
-    gitEmail || u_in_argv || "Jenkins "
-  } ${JerkinsURL ? `from JerkinsURL:  ${JerkinsURL}` : ""} `;
-
-  const project = new ci.Project({
-    appid: APP_ID,
-    type: "miniProgram",
-    projectPath: PROJECT_PATH,
-    privateKeyPath: isJerkin
-      ? PRIVATE_KEY_PATH_JENKINS.replace("${APP_ID}", APP_ID)
-      : PRIVATE_KEY_PATH_LOCAL.replace("${APP_ID}", APP_ID),
-    ignores: ["node_modules/**/*"],
-  });
-
-  // 上传小程序
-
-  console.log("========= 运行上传小程序函数 ==========");
-  const uploadResult = await ci.upload({
-    project,
-    robot: ENV_MAP[ENV].robot,
-    version: version,
-    desc: fullDesc,
-    setting: {
-      useProjectConfig: true,
-    },
-    // onProgressUpdate: console.log,
-  });
-  console.log("上传小程序结果 uploadResult: ", uploadResult);
-
-  console.log("========= 运行预览并生成二维码函数 ==========");
-  const qrCodePath = `${
-    isJerkin ? PREVIEW_CODE_PATH_JENKINS : PREVIEW_CODE_PATH_LOCAL
-  }/${PREVIEW_CODE_FILE_NAME.replace("${version}", version)}`;
-  const previewResult = await ci.preview({
-    project,
-    robot: ENV_MAP[ENV].robot,
-    desc: `${version} ${fullDesc}`,
-    setting: {
-      useProjectConfig: true,
-    },
-    qrcodeFormat: "image",
-    qrcodeOutputDest: qrCodePath, // 服务器链接，可以定期清除，这个是必填字段
-    // onProgressUpdate: console.log,
-  });
-  console.log(
-    `二维码路径：${qrCodePath} （可能不生效或无权限，建议直接从小程序助手进入查看）`
-  );
-  console.log("预览并生成二维码结果 previewResult: ", previewResult);
-
-  console.log("========= 小程序上传结果 ==========");
-  console.log(`由机器人${ENV_MAP[ENV].robot}上传`);
-  console.log(`版本：${version}`);
-  console.log(`描述： ${fullDesc}`);
-  console.log("============  end  ==============");
-};
-
-(async () => {
-  if (!ENV_MAP[ENV]) {
-    console.error("env is not supported: ", ENV);
-    return;
-  }
-
-  if (!v_in_argv || !APP_ID || !PROJECT_PATH) {
-    console.error("version is required");
-
-    const questions = [];
-
-    if (!APP_ID) {
-      questions.push({
-        type: "input",
-        name: "appid",
-        message: "请输入小程序ID",
-      });
-    }
-
-    if (!PROJECT_PATH) {
-      questions.push({
-        type: "input",
-        name: "projectPath",
-        message: "请输入小程序项目打包后的代码路径",
-      });
-    }
-
-    if (!v_in_argv) {
-      questions.push({
-        type: "input",
-        name: "version",
-        message: "请输入版本号",
-      });
-    }
-    if (!d_in_argv) {
-      questions.push({
-        type: "input",
-        name: "desc",
-        message: "请输入版本描述",
-      });
-    }
-
-    inquirer.prompt(questions).then(function (answers) {
-      let { version = "", desc = "", appid = "", projectPath = "" } = answers;
-
-      v_in_argv = version;
-      if (desc) d_in_argv = desc;
-      if (appid) APP_ID = appid;
-      if (projectPath) PROJECT_PATH = projectPath;
-      if (version) {
-        executeUploadMPCode();
-      } else {
-        console.log("版本号不能为空");
-      }
-    });
-    return;
-  } else {
-    executeUploadMPCode();
-  }
-})();