更新代码库
如何保持您的 MkSaaS 项目与最新仓库代码同步
MkSaaS 会保持定期更新、错误修复和安全补丁。本文档解释了如何将您的项目更新到最新版本。
您可以将您的代码库更新到最新版本,但需要注意,您对应用程序进行的自定义越多,更新过程就越复杂,请保持耐心。因为更新涉及使用 Git 将您的自定义代码重新基于最新的 MkSaaS 模板代码之上,所以可能需要解决合并冲突,并仔细处理以保留您的自定义代码。
在更新代码库之前,请确保您的 Git 仓库是干净的,没有未提交的更改。
更新过程
如果您使用 Git 仓库开始项目,您可以直接拉取更新。
# 如果您还没有添加上游远程仓库
git remote add upstream https://github.com/MkSaaSHQ/mksaas-template.git
# 获取最新更改
git fetch upstream
# 为更新创建新分支
git checkout -b update-mksaas
# 合并更改(如有必要解决冲突)
git merge upstream/main依赖项更新
安装新的依赖项:
pnpm install数据库模式更新
当更新包含数据库模式更改时:
- 检查
src/db/app.schema.ts、src/db/auth.schema.ts和src/db/migrations/中的变更。 - 如果模板更新已经包含迁移文件,请保留并直接应用该迁移,不要为同一变更再次运行
db:generate。 - 先在本地或测试数据库中应用待执行的迁移:
pnpm db:migrate- 对生产数据库执行迁移前,确认生产环境数据库地址、迁移历史和备份。
- 只有在您自行修改了数据库模式且尚无迁移文件时,才运行:
pnpm db:generate更新后测试
更新后,彻底测试您的应用程序:
- 运行开发服务器:
pnpm run dev- 检查控制台错误
- 测试关键用户流程
- 运行完整的本地校验:
pnpm check- 如果更新改变了应用行为,运行端到端测试:
pnpm e2e- 发布较大范围的模板更新前,运行升级验证:
pnpm verify:upgrade接收更新通知
要接收 MkSaaS 的更新通知:
- 关注 GitHub 仓库
- 定期查看路线图
- 加入 Discord 社区
- 在 Twitter/X 和其他社交平台上关注 MkSaaS
视频教程
下一步
现在您了解了如何保持您的 MkSaaS 项目最新,探索这些相关主题:
MkSaaS文档