- 安装依赖,为解决各个包之间的依赖关系、版本冲突、同步开发等问题,推荐使用 pnpm 工具,根目录下运行:
pnpm install- 切换为 debug 开发模式,根目录下运行
pnpm run start-debug-mode- 启动测试项目 app1,根目录下运行
pnpm --filter app1 dev- 切换为构建模式,根目录下运行
pnpm run start-build-mode- 注意:打包前需优先打包earthsdk3以生成最新的dist !!!
- 构建四个包的构建,各自目录下运行 如:earthsdk/earthsdk3下
pnpm run build- earthsdk3-assets 是静态资源,无需构建
- 注意交叉引用关系: 只有 earthsdk3 可在 earthsdk3-cesium 、earthsdk3-ue、earthsdk3-ol 中引用,其他引用模式都不行!
- "change-mode.js" 提供了开发模式和构建模式快速切换,debug 模式下使用 demos/app1 来调试,构建时先切换为 build 模式;
- earthsdk3-assets 是静态资源包,静态资源使用环境变量获取路径 ${earthsdk3-assets-script-dir}/assets/xxx;
- feat: 新增功能
- fix: 修复 bug
- perf: 改进性能的代码更改
- revert: 代码回滚
(以上信息需注意尽量详细,会被收集作为更新日志!)
- docs:文档变更
- style:代码格式变更(不影响代码运行)
- refactor:代码重构(既不是修复 bug 也不是新增功能)
- test:测试相关变更
- build:构建系统或外部依赖变更
- ci:CI 配置文件和脚本变更
- chore:其他不修改 src 或测试文件的变更
示例:feat(ESSceneObject):新增 getSceneObjById(id) 函数
- 先添加新版本 tag ,再运行(根目录下) pnpm run docs:build
- 修复版本如 3.6.0 的修复版本 3.6.1 需要提交修复日志确保CHANGELOG.md文档能够识别到
- 文档生成的顺序:生成版本日志CHANGELOG.md(日志文件处理),生成typedoc文档,生成pagefind文档搜索索引,打包对象搜索页guide后copy