shipfe 1.1.1 → 1.1.3

package/docs/zh/config/schema.md

@@ -1,253 +0,0 @@
-# 配置架构
-
-完整的Shipfe配置文件架构说明。
-
-## 必需配置
-
-### remote_host
-
-服务器主机名或IP地址。
-
-```json
-{
-  "remote_host": "your-server.com"
-}
-```
-
-### remote_user
-
-SSH登录用户名。
-
-```json
-{
-  "remote_user": "deploy"
-}
-```
-
-### remote_path
-
-服务器上的部署根目录。
-
-```json
-{
-  "remote_path": "/var/www/myapp"
-}
-```
-
-### local_path
-
-本地构建输出目录。
-
-```json
-{
-  "local_path": "./dist"
-}
-```
-
-## 可选配置
-
-### build_command
-
-部署前执行的构建命令。
-
-```json
-{
-  "build_command": "npm run build"
-}
-```
-
-### keep_releases
-
-保留的发布版本数量。默认值：5
-
-```json
-{
-  "keep_releases": 10
-}
-```
-
-### delete_old
-
-是否只保留最新版本，删除所有旧版本。默认值：false
-
-```json
-{
-  "delete_old": true
-}
-```
-
-### enable_shared
-
-启用共享资源功能。默认值：false
-
-```json
-{
-  "enable_shared": true
-}
-```
-
-### hashed_asset_patterns
-
-共享资源的文件匹配模式。默认值：常见的静态资源类型
-
-```json
-{
-  "hashed_asset_patterns": [
-    "**/*.js",
-    "**/*.css",
-    "**/*.png",
-    "**/*.jpg",
-    "**/*.svg",
-    "**/*.woff2"
-  ]
-}
-```
-
-### exclude_patterns
-
-部署时排除的文件模式。
-
-```json
-{
-  "exclude_patterns": [
-    "**/*.map",
-    "**/*.log",
-    "**/.DS_Store"
-  ]
-}
-```
-
-### ssh_key_path
-
-SSH私钥路径。默认值：`~/.ssh/id_rsa`
-
-```json
-{
-  "ssh_key_path": "~/.ssh/deploy_key"
-}
-```
-
-### ssh_port
-
-SSH连接端口。默认值：22
-
-```json
-{
-  "ssh_port": 2222
-}
-```
-
-### pre_deploy_commands
-
-部署前在服务器上执行的命令数组。
-
-```json
-{
-  "pre_deploy_commands": [
-    "sudo systemctl stop nginx",
-    "cd /var/www/myapp && php artisan down"
-  ]
-}
-```
-
-### post_deploy_commands
-
-部署后在服务器上执行的命令数组。
-
-```json
-{
-  "post_deploy_commands": [
-    "cd /var/www/myapp/current && php artisan migrate",
-    "sudo systemctl start nginx",
-    "cd /var/www/myapp/current && php artisan up"
-  ]
-}
-```
-
-## 配置类型
-
-### 字符串类型
-
-- `remote_host`
-- `remote_user`
-- `remote_path`
-- `local_path`
-- `build_command`
-- `ssh_key_path`
-
-### 数字类型
-
-- `keep_releases`
-- `ssh_port`
-
-### 布尔类型
-
-- `delete_old`
-- `enable_shared`
-
-### 数组类型
-
-- `hashed_asset_patterns`: 字符串数组
-- `exclude_patterns`: 字符串数组
-- `pre_deploy_commands`: 字符串数组
-- `post_deploy_commands`: 字符串数组
-
-## 模式语法
-
-文件匹配模式使用 glob 语法：
-
-- `*` - 匹配任意字符（不含路径分隔符）
-- `**` - 匹配任意字符（包含路径分隔符）
-- `?` - 匹配单个字符
-- `[abc]` - 匹配括号内的任意字符
-- `{a,b,c}` - 匹配大括号内的任意模式
-
-### 示例
-
-```json
-{
-  "hashed_asset_patterns": [
-    "**/*.js",        // 所有JS文件
-    "**/*.css",       // 所有CSS文件
-    "assets/**/*",    // assets目录下的所有文件
-    "**/*.{png,jpg}"  // 所有PNG和JPG文件
-  ],
-  "exclude_patterns": [
-    "**/*.map",       // 排除源码映射文件
-    "**/*.log",       // 排除日志文件
-    ".git/**",        // 排除Git目录
-    "node_modules/**" // 排除依赖目录
-  ]
-}
-```
-
-## 环境变量
-
-配置文件支持环境变量替换：
-
-```json
-{
-  "remote_host": "$DEPLOY_HOST",
-  "remote_user": "$DEPLOY_USER",
-  "remote_path": "/var/www/$APP_NAME"
-}
-```
-
-使用时设置环境变量：
-
-```bash
-export DEPLOY_HOST=production.example.com
-export DEPLOY_USER=deploy
-export APP_NAME=myapp
-shipfe deploy
-```
-
-## 验证规则
-
-Shipfe 会验证配置的正确性：
-
-- **必需字段**：`remote_host`, `remote_user`, `remote_path`, `local_path`
-- **路径存在**：`local_path` 必须存在
-- **SSH连接**：能够建立SSH连接
-- **权限检查**：服务器目录具有写入权限
-- **模式有效性**：glob模式语法正确

package/docs/zh/config/sub-env.md

@@ -1,293 +0,0 @@
-# 子环境配置
-
-为不同的部署环境配置Shipfe。
-
-## 环境配置文件
-
-为每个环境创建单独的配置文件：
-
-```
-project/
-├── shipfe.config.json          # 默认配置
-├── shipfe.staging.json         # 预发布环境
-├── shipfe.production.json      # 生产环境
-└── shipfe.test.json           # 测试环境
-```
-
-## 环境配置示例
-
-### 开发环境
-
-```json
-// shipfe.dev.json
-{
-  "remote_host": "dev.example.com",
-  "remote_user": "dev",
-  "remote_path": "/var/www/dev/myapp",
-  "local_path": "./dist",
-  "keep_releases": 3,
-  "build_command": "npm run build:dev",
-  "delete_old": false
-}
-```
-
-### 预发布环境
-
-```json
-// shipfe.staging.json
-{
-  "remote_host": "staging.example.com",
-  "remote_user": "deploy",
-  "remote_path": "/var/www/staging/myapp",
-  "local_path": "./dist",
-  "keep_releases": 5,
-  "build_command": "npm run build:staging",
-  "enable_shared": true,
-  "pre_deploy_commands": [
-    "cd /var/www/staging/myapp && php artisan down"
-  ],
-  "post_deploy_commands": [
-    "cd /var/www/staging/myapp/current && php artisan migrate",
-    "cd /var/www/staging/myapp/current && php artisan up"
-  ]
-}
-```
-
-### 生产环境
-
-```json
-// shipfe.production.json
-{
-  "remote_host": "production.example.com",
-  "remote_user": "deploy",
-  "remote_path": "/var/www/production/myapp",
-  "local_path": "./dist",
-  "keep_releases": 10,
-  "build_command": "npm run build:production",
-  "enable_shared": true,
-  "hashed_asset_patterns": [
-    "**/*.js",
-    "**/*.css",
-    "**/*.png",
-    "**/*.jpg",
-    "**/*.svg",
-    "**/*.woff2",
-    "**/*.woff"
-  ],
-  "exclude_patterns": [
-    "**/*.map",
-    "**/*.log",
-    "**/.*"
-  ],
-  "pre_deploy_commands": [
-    "sudo systemctl stop nginx",
-    "cd /var/www/production/myapp && php artisan down"
-  ],
-  "post_deploy_commands": [
-    "cd /var/www/production/myapp/current && php artisan migrate --force",
-    "cd /var/www/production/myapp/current && php artisan config:cache",
-    "cd /var/www/production/myapp/current && php artisan route:cache",
-    "cd /var/www/production/myapp/current && php artisan view:cache",
-    "sudo systemctl start nginx",
-    "cd /var/www/production/myapp/current && php artisan up"
-  ]
-}
-```
-
-## 使用环境配置
-
-### 指定配置文件
-
-```bash
-# 部署到预发布环境
-shipfe deploy --config shipfe.staging.json
-
-# 部署到生产环境
-shipfe deploy --config shipfe.production.json
-
-# 回滚预发布环境
-shipfe rollback --config shipfe.staging.json
-```
-
-### 环境变量
-
-使用环境变量简化配置：
-
-```json
-// shipfe.config.json
-{
-  "remote_host": "$DEPLOY_HOST",
-  "remote_user": "$DEPLOY_USER",
-  "remote_path": "$DEPLOY_PATH",
-  "build_command": "$BUILD_COMMAND"
-}
-```
-
-```bash
-# 设置环境变量
-export DEPLOY_HOST=staging.example.com
-export DEPLOY_USER=deploy
-export DEPLOY_PATH=/var/www/staging/myapp
-export BUILD_COMMAND="npm run build:staging"
-
-shipfe deploy
-```
-
-### npm脚本
-
-在 `package.json` 中定义部署脚本：
-
-```json
-{
-  "scripts": {
-    "deploy:dev": "shipfe deploy --config shipfe.dev.json",
-    "deploy:staging": "shipfe deploy --config shipfe.staging.json",
-    "deploy:prod": "shipfe deploy --config shipfe.production.json",
-    "rollback:staging": "shipfe rollback --config shipfe.staging.json",
-    "rollback:prod": "shipfe rollback --config shipfe.production.json"
-  }
-}
-```
-
-使用：
-
-```bash
-npm run deploy:staging
-npm run deploy:prod
-```
-
-## 环境差异配置
-
-### 构建命令差异
-
-不同环境可能需要不同的构建配置：
-
-```json
-// 开发环境 - 快速构建，无优化
-{
-  "build_command": "npm run build:dev"
-}
-
-// 生产环境 - 完整构建，优化
-{
-  "build_command": "npm run build:production"
-}
-```
-
-### 资源处理差异
-
-```json
-// 预发布环境 - 启用源码映射
-{
-  "exclude_patterns": []
-}
-
-// 生产环境 - 排除源码映射
-{
-  "exclude_patterns": [
-    "**/*.map"
-  ]
-}
-```
-
-### 部署钩子差异
-
-```json
-// 开发环境 - 简单重启
-{
-  "post_deploy_commands": [
-    "touch current/tmp/restart.txt"
-  ]
-}
-
-// 生产环境 - 完整部署流程
-{
-  "pre_deploy_commands": [
-    "sudo systemctl stop nginx"
-  ],
-  "post_deploy_commands": [
-    "sudo systemctl start nginx"
-  ]
-}
-```
-
-## 配置继承
-
-使用配置继承减少重复：
-
-```javascript
-// config.js
-const baseConfig = {
-  local_path: "./dist",
-  keep_releases: 5,
-  enable_shared: true
-};
-
-const environments = {
-  dev: {
-    ...baseConfig,
-    remote_host: "dev.example.com",
-    build_command: "npm run build:dev"
-  },
-  staging: {
-    ...baseConfig,
-    remote_host: "staging.example.com",
-    build_command: "npm run build:staging"
-  },
-  production: {
-    ...baseConfig,
-    remote_host: "production.example.com",
-    build_command: "npm run build:production",
-    keep_releases: 10
-  }
-};
-
-module.exports = environments;
-```
-
-然后生成JSON配置文件：
-
-```bash
-node -e "console.log(JSON.stringify(require('./config.js').production, null, 2))" > shipfe.production.json
-```
-
-## 安全考虑
-
-### 敏感信息
-
-不要在配置文件中存储敏感信息：
-
-```json
-// ❌ 不安全
-{
-  "database_password": "secret123"
-}
-
-// ✅ 使用环境变量
-{
-  "database_password": "$DB_PASSWORD"
-}
-```
-
-### 权限控制
-
-为配置文件设置适当权限：
-
-```bash
-# 配置文件权限
-chmod 600 shipfe.*.json
-
-# 环境变量文件权限
-chmod 600 .env
-```
-
-### 密钥管理
-
-为不同环境使用不同的SSH密钥：
-
-```json
-// 生产环境使用专用密钥
-{
-  "ssh_key_path": "~/.ssh/production_deploy_key"
-}
-```