SMF Core 脚本集合
本目录包含 SMF Core 项目的各种自动化脚本,用于简化开发、构建、测试和部署流程。
脚本目录结构
scripts/
├── build.sh # 构建脚本,用于编译、测试和打包项目
├── clean.sh # 清理脚本,用于删除构建文件和临时文件
├── README.md # 脚本说明文档(当前文件)
├── code-quality/ # 代码质量相关脚本
│ └── check-code.sh # 运行代码质量分析工具
├── development/ # 开发环境相关脚本
│ ├── setup-env.sh # 设置开发环境、配置文件
│ └── start-dev.sh # 启动开发服务器
└── deploy/ # 部署相关脚本
└── deploy-dev.sh # 部署到开发环境
使用方法
构建项目
# 运行构建脚本(编译、测试、打包)
./scripts/build.sh
设置开发环境
# 设置开发环境
./scripts/development/setup-env.sh
# 启动开发服务器
./scripts/development/start-dev.sh
清理项目
# 清理构建文件和临时文件
./scripts/clean.sh
检查代码质量
# 运行代码质量检查(Checkstyle、SpotBugs等)
./scripts/code-quality/check-code.sh
部署应用
# 部署到开发环境
./scripts/deploy/deploy-dev.sh
前提条件
- Maven: 所有脚本都需要 Maven 3.6+ 才能运行
- Java: JDK 11 或更高版本
- 部署脚本: SSH 访问权限(用于远程部署)
脚本权限
首次使用脚本前,确保脚本具有执行权限:
chmod +x ./scripts/*.sh
chmod +x ./scripts/*/*.sh
自定义配置
大多数脚本都包含可自定义的配置变量,位于脚本顶部。根据您的环境需求,可以调整这些变量。
注意事项
- 始终确保您了解脚本的作用再执行它
- 某些脚本可能会修改文件或执行远程操作
- 在生产环境使用前,建议在测试环境验证脚本的行为
- 保持脚本更新,随着项目发展调整脚本功能