auto-deploy-sh 2.0.1 → 2.1.0

package/README.md

@@ -1,121 +1,128 @@
-# Auto-deploy-sh
-
-English|[简体中文](README_zh_CN.md)
-
-This project aims to lower deployment barriers by providing an ultra-simple configuration and minimal dependency automated Docker deployment workflow. It helps developers quickly deploy applications to cloud servers without complex environment setups.
-
-## Deployment Commands
-
-### Project-Specific Configuration
-
-**Install:**
-
-```bash
-npm install auto-deploy-sh -D
-```
-
-**Run:**
-
-- Add to `package.json`:
-
-```json
-"scripts": {
-  "deploy": "auto-deploy-sh"
-}
-```
-
-2. Execute in terminal:
-
-```bash
-npm run deploy
-```
-
-### Global Configuration
-
-**Install:**
-
-```bash
-npm install auto-deploy-sh -g
-```
-
-**Run** (in the root directory of the project to deploy):
-
-```bash
-auto-deploy-sh
-```
-
-### Advanced Usage
-
-Run with a **custom configuration file**:
-
-```bash
-auto-deploy <config-path>
-# OR
-auto-deploy -f <config-path>
-```
-
-Useful for multi-environment deployment (e.g., development, staging, production).
-
-## Configuration File Reference
-
-The configuration file is **fixed as `deploy-config.json`**. If missing, the tool will **guide you to create it** (stored in the command execution directory by default) and automatically add `deploy-config.json` to `.gitignore` to **prevent accidental commits of sensitive data**.
-
-> ⚠️ **Critical Note**: The configuration file contains sensitive information (e.g., passwords). If creating manually, ensure `deploy-config.json` is added to `.gitignore`.
-
-### Configuration Properties
-
-- `host`: Remote server IP address or domain name.
-- `port`: SSH port number.
-- `user`: SSH username for the remote server.
-- `password`: Password for the SSH user.
-- `beforLaunch`: **Pre-deployment commands** (array of strings) to execute locally before starting the deployment (e.g., `["npm run build"]`).
-- `Dockerfile`: **Optional**. If omitted: 1. Check `dockerBuildFiles` for a file named `Dockerfile`; 2. If not found, search for `Dockerfile` in the **first-level directory of the current execution environment**.
-- `dockerBuildFiles`: Files/directories to include in the Docker build context (required for Dockerfile execution).
-- `imageTag`: Docker image tag, formatted as `[registry-url/][username/project-name]:[tag]` (e.g., `my-registry.com/user/my-app:v1.0`).
-- `containerName`: Unique name for the running container (ensures no conflicts with existing containers).
-- `BindPorts`: Port mapping, formatted as `<host-port>:<container-port>` (e.g., `"8080:80"`).
-- `Options`: **Optional** advanced settings (all sub-properties are optional)
-  - `volumes`: Volume mappings (array of strings), formatted as `[host-path/volume-name]:[container-path]:[optional-flags]` (e.g., `["/host/data:/container/data:ro"]`).
-  - `networks`: Connect the container to a custom Docker network (created via `docker network create <network-name>`) for inter-container communication.
-
-### Format Introduction
-
-```json
-{
-  "host": "string",
-  "port": "number | string",
-  "user": "string",
-  "password": "string",
-  "beforLaunch": "string[]",
-  "Dockerfile": "string",
-  "dockerBuildFiles": "string[]",
-  "imageTag": "string",
-  "containerName": "string",
-  "BindPorts": "string",
-  "Options": {
-    "volumes": "string[]",
-    "networks": "string"
-  }
-}
-```
-
-### Full Configuration Example
-
-```json
-{
-  "host": "your-server-ip",
-  "port": 22,
-  "user": "ssh-username",
-  "password": "ssh-password",
-  "beforLaunch": ["npm run build"],
-  "Dockerfile": "./Dockerfile",
-  "dockerBuildFiles": ["./dist", "./package.json"],
-  "imageTag": "my-app:latest",
-  "containerName": "my-app-container",
-  "BindPorts": "80:80",
-  "Options": {
-    "volumes": ["/host/logs:/app/logs:rw"],
-    "networks": "my-custom-network"
-  }
-}
-```
+# Auto-deploy-sh
+
+English|[简体中文](README_zh_CN.md)
+
+This project aims to lower deployment barriers by providing an ultra-simple configuration and minimal dependency automated Docker deployment workflow. It helps developers quickly deploy applications to cloud servers without complex environment setups.
+
+## Deployment Commands
+
+### Project-Specific Configuration
+
+**Install:**
+
+```bash
+npm install auto-deploy-sh -D
+```
+
+**Run:**
+
+- Add to `package.json`:
+
+```json
+"scripts": {
+  "deploy": "auto-deploy-sh"
+}
+```
+
+2. Execute in terminal:
+
+```bash
+npm run deploy
+```
+
+### Global Configuration
+
+**Install:**
+
+```bash
+npm install auto-deploy-sh -g
+```
+
+**Run** (in the root directory of the project to deploy):
+
+```bash
+auto-deploy-sh
+```
+
+### Advanced Usage
+
+Run with a **custom configuration file**:
+
+```bash
+auto-deploy-sh <config-path>
+# OR
+auto-deploy-sh -f <config-path>
+```
+
+Useful for multi-environment deployment (e.g., development, staging, production).
+
+## Configuration File Reference
+
+The configuration file is **fixed as `deploy-config.json`**. If missing, the tool will **guide you to create it** (stored in the command execution directory by default) and automatically add `deploy-config.json` to `.gitignore` to **prevent accidental commits of sensitive data**.
+
+> ⚠️ **Critical Note**: The configuration file contains sensitive information (e.g., passwords). If creating manually, ensure `deploy-config.json` is added to `.gitignore`.
+
+### Configuration Properties
+
+- `host`: Remote server IP address or domain name.
+- `port`: SSH port number.
+- `user`: SSH username for the remote server.
+- `password`: Password for the SSH user.
+- `beforLaunch`: **Pre-deployment commands** (array of strings) to execute locally before starting the deployment (e.g., `["npm run build"]`).
+- `Dockerfile`: **Optional**. If omitted: 1. Check `dockerBuildFiles` for a file named `Dockerfile`; 2. If not found, search for `Dockerfile` in the **first-level directory of the current execution environment**.
+- `dockerBuildFiles`: Files/directories to include in the Docker build context (required for Dockerfile execution).
+- `imageTag`: Docker image tag, formatted as `[registry-url/][username/project-name]:[tag]` (e.g., `my-registry.com/user/my-app:v1.0`).
+- `containerName`: Unique name for the running container (ensures no conflicts with existing containers).
+- `BindPorts`: Port mapping, formatted as `<host-port>:<container-port>` (e.g., `"8080:80"`).
+- `restart` (optional): Container restart policy, controls how Docker handles container restarts. The following options are supported:
+  - `no`(default): The container **will not restart automatically after it exits**. It will also remain stopped after Docker or system restarts. Suitable for one-off tasks or debugging scenarios.
+  - `always`: The container **will always restart automatically** if it stops. It will also start automatically after Docker or system restarts.Even if the container is manually stopped, it will be restarted again after Docker restarts.
+  - `unless-stopped`(recommended): The container will automatically restart on failure and start after Docker or system restarts.**If the container is manually stopped, it will not be restarted again**, making it suitable for long-running production services.
+  - `on-failure`: The container **will restart only if it exits with a non-zero status code**. It will not restart on normal exits (exit code 0).
+- `Options`: **Optional** advanced settings (all sub-properties are optional)
+  - `volumes`: Volume mappings (array of strings), formatted as `[host-path/volume-name]:[container-path]:[optional-flags]` (e.g., `["/host/data:/container/data:ro"]`).
+  - `networks`: Connect the container to a custom Docker network (created via `docker network create <network-name>`) for inter-container communication.
+
+### Format Introduction
+
+```json
+{
+  "host": "string",
+  "port": "number | string",
+  "user": "string",
+  "password": "string",
+  "beforLaunch": "string[]",
+  "Dockerfile": "string",
+  "dockerBuildFiles": "string[]",
+  "imageTag": "string",
+  "containerName": "string",
+  "BindPorts": "string",
+  "restart": "'no' | 'always' | 'unless-stopped' | 'on-failure'",
+  "Options": {
+    "volumes": "string[]",
+    "networks": "string[]"
+  }
+}
+```
+
+### Full Configuration Example
+
+```json
+{
+  "host": "your-server-ip",
+  "port": 22,
+  "user": "ssh-username",
+  "password": "ssh-password",
+  "beforLaunch": ["npm run build"],
+  "Dockerfile": "./Dockerfile",
+  "dockerBuildFiles": ["./dist", "./package.json"],
+  "imageTag": "my-app:latest",
+  "containerName": "my-app-container",
+  "BindPorts": "80:80",
+  "restart": "unless-stopped",
+  "Options": {
+    "volumes": ["/host/logs:/app/logs:rw"],
+    "networks": ["my-custom-network", "my-custom-network-1"]
+  }
+}
+```

package/dist/bin/config.js

@@ -43,6 +43,32 @@ const configMethod = {
         type: 'input',
         message: 'Bind Ports(such as 8080:8080): ',
     },
+    restart: {
+        type: 'select',
+        message: 'Container restart policy (when should Docker restart this container?)',
+        choices: [
+            {
+                name: 'no (default)',
+                value: 'no',
+                description: 'Never restart. Container stays stopped even after Docker or system restarts.',
+            },
+            {
+                name: 'always',
+                value: 'always',
+                description: 'Always restart if it stops. Will also start automatically after Docker or system reboot.',
+            },
+            {
+                name: 'unless-stopped (recommended)',
+                value: 'unless-stopped',
+                description: 'Restart automatically unless you manually stop it. Will NOT restart again if stopped by user.',
+            },
+            {
+                name: 'on-failure',
+                value: 'on-failure',
+                description: 'Restart only on non-zero exit code. Useful for jobs or scripts that may fail.',
+            },
+        ],
+    },
 };
 const optionsMethod = {
     volumes: {
@@ -52,7 +78,8 @@ const optionsMethod = {
     },
     networks: {
         type: 'input',
-        message: 'Bound network: ',
+        message: 'Bound networks (separated by , ): ',
+        handleFn: (value) => value.split(','),
     },
 };
 export async function createConfig(rootPath) {

package/dist/bin/deploy.d.ts

@@ -29,5 +29,6 @@ export declare class Deploy {
     dockcerImageBuild(ssh: NodeSSH): Promise<void>;
     buildDocker(ssh: NodeSSH, IMAGE_TAG: string, REMOTEAPPPATH: string, TARGET_DIR: string, CONTAINER_NAME: string): Promise<void>;
     runDocker(ssh: NodeSSH, CONTAINER_NAME: string): Promise<void>;
+    judgeNetwork(ssh: NodeSSH, networks: string[]): Promise<void>;
     clear(ssh: NodeSSH): Promise<void>;
 }

package/dist/bin/deploy.js

@@ -1,4 +1,4 @@
-import { log, ora, run, fs, exit, chalk } from "./utils/index.js";
+import { log, ora, run, fs, exit, chalk, inquirer } from "./utils/index.js";
 import path from 'path';
 import archiver from 'archiver';
 export class Deploy {
@@ -186,6 +186,10 @@ export class Deploy {
             const REMOTE_PATH = this.remotePath;
             const IMAGE_TAG = this.config.imageTag;
             const TARGET_DIR = `./${CONTAINER_NAME}`;
+            const networks = this.config.Options?.networks || [];
+            if (networks.length > 0) {
+                await this.judgeNetwork(ssh, networks);
+            }
             await this.execCommand(ssh, {
                 startMsg: 'Start decompress project....',
                 succMsg: 'Decompress project completed.',
@@ -235,6 +239,9 @@ export class Deploy {
     }
     async runDocker(ssh, CONTAINER_NAME) {
         let optionsCLI = `--name ${CONTAINER_NAME} -p ${this.config.BindPorts}`;
+        if (this.config.restart) {
+            optionsCLI += ` --restart ${this.config.restart}`;
+        }
         const options = this.config.Options;
         if (options) {
             const optionsKeys = Object.keys(options);
@@ -248,7 +255,14 @@ export class Deploy {
                             break;
                         }
                         case 'networks': {
-                            optionsCLI += ` --network ${options.networks}`;
+                            let cli = '';
+                            if (Array.isArray(options.networks)) {
+                                cli = options.networks.map((network) => `--network ${network}`).join(' ');
+                            }
+                            else {
+                                cli = `--network ${options.networks}`;
+                            }
+                            optionsCLI += ` ${cli}`;
                             break;
                         }
                         default:
@@ -265,6 +279,35 @@ export class Deploy {
         docker run -d ${optionsCLI}
       `);
     }
+    async judgeNetwork(ssh, networks) {
+        const { stderr, code, stdout } = await ssh.execCommand(`docker network ls --format '{{.Name}}'`);
+        if (code !== 0 || (stderr && code !== 0)) {
+            stderr && log.error(stderr);
+            throw new Error();
+        }
+        const existNetworks = new Set(stdout
+            .split('\n')
+            .map(item => item.trim())
+            .filter(Boolean));
+        const missingNetworks = networks.filter(network => !existNetworks.has(network));
+        if (missingNetworks.length > 0) {
+            const answer = await inquirer.invoke({
+                type: 'confirm',
+                message: `The following Docker networks do not exist:\n${JSON.stringify(missingNetworks)}\nDo you want to create them now?`,
+            });
+            if (answer) {
+                let cli = missingNetworks.map(name => `docker network create ${name}`).join(' && ');
+                await this.execCommand(ssh, {
+                    startMsg: `Creating missing Docker networks...`,
+                    succMsg: `Missing Docker networks created successfully.`,
+                }, cli);
+            }
+            else {
+                log.error('Deployment aborted due to missing Docker networks.');
+                throw new Error();
+            }
+        }
+    }
     async clear(ssh) {
         await ssh.execCommand(`rm -f ${this.remotePath}`);
         await ssh.execCommand(`rm -rf ${this.REMOTEAPPPATH}/${this.config.containerName}`);

package/dist/bin/type/types.d.ts

@@ -10,9 +10,10 @@ export type sshConfig = {
     imageTag: string;
     containerName: string;
     BindPorts: string;
+    restart?: 'no' | 'always' | 'on-failure' | 'unless-stopped';
     Options: {
         volumes: string[];
-        networks: string;
+        networks: string[];
     };
 };
 export type fileData = string | NodeJS.ArrayBufferView;

package/dist/bin/utils/inquirer.js

@@ -31,7 +31,7 @@ export class inquirer {
                 break;
             case 'confirm':
                 args.theme = {
-                    prefix: chalk.warn('✔'),
+                    prefix: chalk.warn('?'),
                     style: {
                         answer: (text) => chalk.done(text),
                         error: (text) => chalk.error(text),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-deploy-sh",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Automated Docker deployment tool",
   "bin": {
     "auto-deploy-sh": "./dist/cli/index.js"