@wjwjq/release-helper 0.1.4 → 0.1.6

package/dist/.release/doc//351/203/250/347/275/262/346/211/213/345/206/214.md

@@ -182,10 +182,11 @@ chmod +x upgrade.sh
 | 安装目录           | /opt/$APP_NAME$/                                     |
 | 版本文件           | /opt/$APP_NAME$/version                              |
 | nginx配置文件      | /opt/$APP_NAME$/nginx/nginx.conf                     |
-| 日志文件位置       | /var/log/nginx/$APP_NAME$.log                        |
+| 日志文件位置       | /var/log/$APP_NAME$/nginx.log                        |
 | 系统静态资源目录   | /opt/$APP_NAME$/assets/                              |
 | 系统配置文件       | /opt/$APP_NAME$/assets/settings                      |
 | system service位置 | /usr/lib/systemd/system/$APP_NAME$.nginx.service     |
+| 日志翻转配置位置 | /etc/logrotate.d/$APP_NAME$.nginx     |
 
 ## 4.2 启动命令
 
@@ -414,21 +415,4 @@ tar: Error is not recoverable: exiting now
 
 页面配置： **最新版配置文件，请查看最新版本$APP_NAME$.tar.gz解压路径"/$APP_NAME$/pkg/assets/settings"**
 
-nginx配置： **最新版配置文件，请查看最新版本$APP_NAME$.tar.gz解压路径"/$APP_NAME$/pkg/nginx/nginx.conf"**
-
-## 5.1 v1.7.0
-
-无变更， 无需手动修改
-
-## 5.2 v1.8.0
-
-新增配置项 安全事件返回条数限制
-
-```text
-# 第5行
-systemSafeEventDate.limit=43200
-````
-
-## 5.3 v1.9.0
-
-无变更， 无需手动修改
+nginx配置： **最新版配置文件，请查看最新版本$APP_NAME$.tar.gz解压路径"/$APP_NAME$/pkg/nginx/nginx.conf"**

package/dist/.release/release.conf.yaml

@@ -10,6 +10,8 @@ assetsDir: 'dist'
 # nginx和assets 所属用户和用户组
 user: root
 userGroup: root
+# 安装目录
+installDir: /opt
 
 # 指定安装模式  standalone(supervisor) 、 cluster（agent\systemd) 、 both
 installMode: both

package/dist/cli.js

@@ -16,7 +16,7 @@ cli.command("init", "generate release configuration").action(async (options) =>
   try {
     logger.info("start to generate .release configuration ");
     const { prepare } = await import('./prepare.js');
-    await prepare();
+    await prepare({ callBy: "init" });
     logger.info("done");
   } catch (e) {
     console.error(`release-helper error: `, e);

package/dist/deploy/pkg/nginx/nginx.logrotate.tpl

@@ -0,0 +1,14 @@
+/var/log/__app_name__/*.log {
+    daily
+    missingok
+    minsize 100M
+    rotate 3
+    compress
+    delaycompress
+    notifempty
+    create 0644 __user__ __usergroup__
+    sharedscripts
+    postrotate
+        [ -f __pid_file__ ] && kill -USR1 `cat __pid_file__`
+    endscript
+}

package/dist/deploy/script/common.sh

@@ -133,34 +133,37 @@ install_assets() {
 }
 
 start() {
-  # 未安装
-  if ((has_nginx_installed == 0)); then
-    install_nginx_binary
-
-    if [[ $? != 0 ]]; then
-      echo "$(tput setaf 1)"failed to install!"$(tput sgr0)"
-      exit 1
+  # 仅静态文件
+  if [[ "${mode}" != 3 ]]; then
+    # 未安装
+    if ((has_nginx_installed == 0)); then
+      install_nginx_binary
+
+      if [[ $? != 0 ]]; then
+        echo "$(tput setaf 1)"failed to install!"$(tput sgr0)"
+        exit 1
+      fi
     fi
-  fi
 
-  # 已安装 询问是否更新nginx
-  if ((has_nginx_installed == 1)); then
-    while true; do
-      read -r -p "Nginx has been installed, re-install it?[Y/N]" yn
-      case $yn in
-      [Yy]*)
-        install_nginx_binary
-        
-        if [[ $? != 0 ]]; then
-          echo "$(tput setaf 1)"failed to install!"$(tput sgr0)"
-          exit 1
-        fi
-        break
-        ;;
-      [Nn]*) break ;;
-      *) echo "Please answer yes or no." ;;
-      esac
-    done
+    # 已安装 询问是否更新nginx
+    if ((has_nginx_installed == 1)); then
+      while true; do
+        read -r -p "Nginx has been installed, re-install it?[Y/N]" yn
+        case $yn in
+        [Yy]*)
+          install_nginx_binary
+          
+          if [[ $? != 0 ]]; then
+            echo "$(tput setaf 1)"failed to install!"$(tput sgr0)"
+            exit 1
+          fi
+          break
+          ;;
+        [Nn]*) break ;;
+        *) echo "Please answer yes or no." ;;
+        esac
+      done
+    fi
   fi
 
   # 创建用户
@@ -179,8 +182,13 @@ start() {
 
   mkdir -p "$install_path"
 
-  copy_nginx_conf_and_write_verison
-  add_nginx_service
+  # 仅静态文件
+  if [[ "${mode}" != 3 ]]; then
+    copy_nginx_conf_and_write_verison
+    add_nginx_service
+    add_log_rotate
+  fi
+
   install_assets
 
   # 修改所属用户

package/dist/deploy/script/nginx.sh

@@ -14,32 +14,26 @@ nginx_conf_install_path="$prefix/opt/${app_name}/nginx/"
 nginx_conf_path="${nginx_conf_install_path}nginx.conf"
 
 # asset_path="$prefix/opt/posidon-frontend/"
-nginx_log_path="/var/log/nginx"
-nginx_log_file="${app_name}.nginx.log"
+nginx_info_path="/var/log/${app_name}"
+nginx_log_file="nginx.log"
 #不放在var/run 是因为重启后 var/run/下面的文件及目录会被清除
-nginx_pid_dir="/var/log/nginx/"
-nginx_pid_file_path="$nginx_pid_dir${app_name}.nginx.pid"
+nginx_pid_file_path="$nginx_info_path/nginx.pid"
 
 conf_version=$(awk '{print $1}' "${pkg_path}"/version)
 echo "$conf_version"
 
 copy_nginx_conf_and_write_verison() {
   mkdir -p "$nginx_conf_install_path"
-  #  创建pid目录
-  mkdir -p $nginx_pid_dir
-  chown -R $user:$usergroup $nginx_pid_dir
-  chmod 744 -R  $nginx_pid_dir
-
-  # 创建日志目录
-  mkdir -p $nginx_log_path
-  touch $nginx_log_path/$nginx_log_file
-  chown -R $user:$usergroup $nginx_log_path
-  chmod 744 -R $nginx_log_path
+  #  创建pid目录. 创建日志目录
+  mkdir -p $nginx_info_path
+  touch $nginx_info_path/$nginx_log_file
+  chown -R $user:$usergroup $nginx_info_path
+  chmod 744 -R $nginx_info_path
 
   access_log_super="access_log /dev/stdout main"
   error_log_super="error_log /dev/stderr warn"
-  access_log="access_log $nginx_log_path/$nginx_log_file main"
-  error_log="error_log $nginx_log_path/$nginx_log_file"
+  access_log="access_log $nginx_info_path/$nginx_log_file main"
+  error_log="error_log $nginx_info_path/$nginx_log_file"
   pid_file="pid  $nginx_pid_file_path"
 
   exec=$(get_exec_path)
@@ -145,16 +139,16 @@ get_exec_cmd() {
 
 add_nginx_service() {
   #添加到服务
-  exec_cmd="$(get_exec_cmd) -e $nginx_log_path/$nginx_log_file"
+  exec_cmd="$(get_exec_cmd) -e $nginx_info_path/$nginx_log_file"
   cp "$pkg_path"/nginx/nginx.service.tpl ./nginx.service
 
-  check_cmd="$exec -t -c $nginx_conf_path -e $nginx_log_path/$nginx_log_file"
+  check_cmd="$exec -t -c $nginx_conf_path -e $nginx_info_path/$nginx_log_file"
   version=$(echo "$conf_version" | grep -oP '\d+\.\d+\.\d+')
 
   sed -i "s#_user_group_#$usergroup#g" ./nginx.service
   sed -i "s#_user_#$user#g" ./nginx.service
   sed -i "s#_exec_cmd_#$exec_cmd #g" ./nginx.service
-  sed -i "s#_log_path_#$nginx_log_path#g" ./nginx.service
+  sed -i "s#_log_path_#$nginx_info_path#g" ./nginx.service
   sed -i "s#_log_file_#$nginx_log_file#g" ./nginx.service
   sed -i "s#_conf_path_#$nginx_conf_path#g" ./nginx.service
   sed -i "s#_version_#$version#g" ./nginx.service
@@ -171,6 +165,21 @@ add_nginx_service() {
     rm -rf /usr/lib/systemd/system/"$app_name".nginx.service
   fi
 }
+
+add_log_rotate(){
+  mkdir -p /etc/logrotate.d
+
+  rm -rf /etc/logrotate.d/${app_name}.nginx
+   #添加日志翻转
+  cp "$pkg_path"/nginx/nginx.logrotate.tpl ./nginx.logrotate
+
+  sed -i "s#__usergroup__#$usergroup#g" ./nginx.logrotate
+  sed -i "s#__user__#$user#g" ./nginx.logrotate
+  sed -i "s#__app_name__#$app_name#g" ./nginx.logrotate
+  sed -i "s#__pid_file__#$nginx_pid_file_path#g" ./nginx.logrotate
+  
+  cp -f ./nginx.logrotate /etc/logrotate.d/${app_name}.nginx
+}
 #------------------------------------ nginx服务配置文件服务 end----------------------------------
 
 
@@ -247,7 +256,7 @@ install_nginx_binary() {
     log_error "nginx installation failed!"
   fi
 
-  cp "$nginx_binary_install_path"sbin/nginx /usr/sbin/
+  ln -sf "$nginx_binary_install_path"sbin/nginx /usr/sbin/nginx
 
   # 修改/etc/nginx 用户(组)
   chown -R $user:$usergroup "$nginx_binary_install_path"

package/dist/deploy/script/prompt.sh

@@ -12,6 +12,8 @@ if [[ "${mode}" == "standalone" ]]; then
   mode=1
 elif [[ "${mode}" == "cluster" ]]; then
   mode=2
+elif [[ "${mode}" == "static" ]]; then
+  mode=3
 else
   mode=''
 fi
@@ -28,6 +30,10 @@ while [ $# -gt 0 ]; do
     mode=2
     shift
     ;;
+  -SS | -static)
+    mode=3
+    shift
+    ;;
   -h | --help)
     echo "supported parameters: "
     echo "-S, -standalone         install for supervisord startup mode, conflict with -C"

package/dist/pack.js

@@ -40,7 +40,8 @@ async function pack(version) {
     fs.writeFileSync(path.resolve(assetsDir, "version"), version, { encoding: "utf-8" });
     fs.writeFileSync(path.resolve(nginxDir, "version"), version, { encoding: "utf-8" });
     logger.info(pc.green(`version: ${version} added`));
-    const assetInstallPath = `/opt/${projectName}/`;
+    const installDir = releaseConf.installDir.endsWith("/") ? releaseConf.installDir.replace(/\/$/, "") : releaseConf.installDir;
+    const assetInstallPath = `${installDir}/${projectName}/`;
     logger.info(pc.green(`start to replace variants in common.sh`));
     replaceFileContent({
       filePath: path.resolve(projectDir, "script", "common.sh"),

package/dist/prepare.js

@@ -7,7 +7,7 @@ import { fileURLToPath } from 'node:url';
 import { logger } from './logger.js';
 import 'picocolors';
 
-const installMode = ["standalone", "cluster", "both"];
+const installMode = ["standalone", "cluster", "static", "all"];
 const __work_dir = process.env.INIT_CWD || process.cwd();
 const __releaseDir = path.resolve(__work_dir, ".release");
 const __filename = fileURLToPath(import.meta.url);
@@ -22,6 +22,11 @@ function parseConf(file) {
     return {};
   }
 }
+function isValidLinuxPath(path2) {
+  const absolutePathPattern = /^\//;
+  const relativePathPattern = /^(\.\/|\.\.\/)/;
+  return absolutePathPattern.test(path2) || relativePathPattern.test(path2);
+}
 const releaseConf = Object.assign({
   host: "",
   token: "",
@@ -31,10 +36,11 @@ const releaseConf = Object.assign({
   assetsDir: "dist",
   user: "root",
   userGroup: "root",
-  installMode: "both"
+  installMode: "both",
+  installDir: "/opt"
 }, parseConf(__releaseConfPath));
 const $ = execa({ encoding: "utf8" });
-async function prepare() {
+async function prepare({ callBy } = { callBy: "postinstall" }) {
   const copyFiles = () => {
     fs.cpSync(path.resolve(__dirname, ".release"), __releaseDir, { recursive: true });
   };
@@ -43,7 +49,7 @@ async function prepare() {
     copyFiles();
     logger.tip(`\u8BF7\u6CE8\u610F\u4FEE\u6539.release/${releaseConfFileName} \u914D\u7F6E\u4FE1\u606F`);
   } else {
-    if (!process.env.INIT_CWD) {
+    if (callBy === "init") {
       const shouldRegenerate = await inquirer.confirm(
         {
           message: ".release\u914D\u7F6E\u5DF2\u5B58\u5728\uFF0C\u662F\u5426\u91CD\u65B0\u751F\u6210\uFF1F"
@@ -78,6 +84,10 @@ async function checkEnvInfo() {
       logger.error(`The field: [${field}]'s value should be one of ${installMode.join(" | ")}`);
       process.exit(1);
     }
+    if (field === "installDir" && !isValidLinuxPath(value)) {
+      logger.error(`The field: [${field}]'s value is not a legal path`);
+      process.exit(1);
+    }
   }
 }
 

package/dist/start_prepare.js

@@ -11,7 +11,7 @@ import 'node:url';
 (async function startPrepare() {
   try {
     logger.info("start to generate .release configuration ");
-    await prepare();
+    await prepare({ callBy: "postinstall" });
     logger.info("done");
   } catch (error) {
     console.error(`release-helper error: `, error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wjwjq/release-helper",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "generate deployment package for frontend, include nginx...",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -63,7 +63,7 @@
     "node": "^18.20.0 || >=20.0.0"
   },
   "scripts": {
-    "localpack": "pnpm link --global",
+    "localpack": "pnpm build && pnpm link --global",
     "postinstall": "node dist/start_prepare.js",
     "build": "rm -rf dist && rollup -c",
     "prepublish": "pnpm build"

package/src/.release/README.md

@@ -1,73 +0,0 @@
-# release-helper
-
-打包 和发布辅助工具, 集成nginx二进制文件，支持supervisor和systemctl启动安装模式
-
-服务器端安装和更新，请看发布后文档
-
-## 使用
-
-### 推荐
-
-在package.json中添加如下命令, 后续通过pnpm pak/pub/publish使用
-
-```bash
-  "pak": "release-helper pack",
-  "pub": "release-helper publish",
-  "release": "release-helper release",
-```
-
-### 单独使用命令
-
-请在项目根目录，使用命令
-
-#### 初始化
-
-常规来讲，通过pnpm安装时，会自动在项目根目录位置，生成.release目录，若未生成，请手动生成
-
-```bash
-release-helper init
-```
-
-#### 打包
-
-仅打包成xx.tar.gz  需指定release.conf.yaml中assetsDir字段
-
-```bash
-release-helper pack
-```
-
-#### 发版
-
-发布git release相关版本； 需指定release.conf.yaml中host等相关字段
-
-```bash
-release-helper release
-```
-
-## .release 目录说明
-
-### doc 目录
-
-用于release时附带的文档，文档中可以使用指定变量占位，后续执行release-helper release时会自动遍历，并替换所有变量
-
-可使用变量及说明:
-
-| **占位符**    | **含义**                                             |
-| ------------- | ---------------------------------------------------- |
-| \$APP\_NAME\$ | 应用名称（自动读取package.json中name字段值）         |
-| \$VERSION\$   | 用户指定的版本号                                     |
-| \$PKG_NAME\$  | tar.gz包名称（值为\$APP_NAME\$\_\$VERSION\$.tar.gz） |
-
-### nginx 目录
-
-用于存放服务器端nginx的启动配置文件等，部分占位说明及占位符请勿删除，会在服务器端安装或更新时，由脚本自动替换
-
-文件说明：
-| **文件或目录** | **说明**                                                  |
-| -------------- | --------------------------------------------------------- |
-| ca             | nginx https使用到的证书，变更时需对应修改nginx.conf中的值 |
-| nginx.conf     | nginx启动时 需要的配置文件                                |
-
-### release.conf.yaml
-
-打包发布相关配置项