LogoMkSaaS文档

更新代码库

如何保持您的 MkSaaS 项目与最新仓库代码同步

MkSaaS 处于积极维护中,定期更新新功能、错误修复和安全补丁。本文档解释了如何将您的项目更新到最新版本。

虽然可以将您的代码库更新到最新版本,但重要的是要注意,您对应用程序进行的自定义越多,更新过程就越复杂。这是因为更新涉及使用 Git 将您的自定义代码重新基于最新的 MkSaaS 代码之上,这可能需要解决合并冲突并仔细处理以保留您的自定义代码。

在更新代码库之前,请确保您的 Git 仓库是干净的,没有未提交的更改。

更新过程

方法 1:使用 Git(推荐)

如果您使用 Git 仓库开始项目,您可以直接拉取更新。有两种方法:

选项 A:合并方法(更安全)

如果您想要更安全的更新过程和清晰的合并点,请选择此选项。

# 如果您还没有添加上游远程仓库
git remote add upstream https://github.com/MkSaaSHQ/mksaas-template.git

# 获取最新更改
git fetch upstream

# 为更新创建新分支
git checkout -b update-mksaas

# 合并更改(如有必要解决冲突)
git merge upstream/main

选项 B:变基方法(更清洁的历史)

如果您更喜欢线性历史,请选择此选项。这种方法更高级,可能需要更多的 Git 经验来解决冲突。

# 如果您还没有添加上游远程仓库
git remote add upstream https://github.com/MkSaaSHQ/mksaas-template.git

# 获取最新更改并变基
git pull upstream main --rebase

如果您有任何合并冲突,您将必须手动解决它们。如果您不确定如何执行此操作,请参考 Git 文档

方法 2:手动更新

如果您更喜欢手动更新或没有使用 Git:

  1. 下载最新版本的 MkSaaS
  2. 将您的自定义文件与新版本进行比较
  3. 有选择地应用更改,重点关注:
    • 依赖项更新的 package.json
    • 配置文件如 next.config.js
    • src/libsrc/components 目录中的核心功能
    • 数据库模式更新的 schema.ts

依赖项更新

安装新的依赖项:

pnpm install
npm install
yarn install
bun install

仅更新依赖项:

# 将所有依赖项更新到最新版本
pnpm update

# 更新特定依赖项
pnpm update next

# 更新到特定版本
pnpm add next@latest
# 将所有依赖项更新到最新版本
npm update

# 更新特定依赖项
npm update next

# 更新到特定版本
npm install next@latest
# 将所有依赖项更新到最新版本
yarn upgrade

# 更新特定依赖项
yarn upgrade next

# 更新到特定版本
yarn add next@latest
# 将所有依赖项更新到最新版本
bun update

# 更新特定依赖项
bun update next

# 更新到特定版本
bun add next@latest

对于主要依赖项更新,请先检查兼容性:

# 检查主要更新
pnpm dlx npm-check-updates

# 应用主要更新(谨慎使用)
pnpm dlx npm-check-updates -u
pnpm install
# 检查主要更新
npx npm-check-updates

# 应用主要更新(谨慎使用)
npx npm-check-updates -u
npm install
# 检查主要更新
yarn dlx npm-check-updates

# 应用主要更新(谨慎使用)
yarn dlx npm-check-updates -u
yarn install
# 检查主要更新
bunx npm-check-updates

# 应用主要更新(谨慎使用)
bunx npm-check-updates -u
bun install

数据库模式更新

当更新包含数据库模式更改时:

  1. 检查 src/db/schema.ts 文件中的迁移文件
  2. 生成迁移文件:
pnpm run db:generate
npm run db:generate
yarn db:generate
bun run db:generate
  1. 应用迁移:
pnpm run db:migrate
npm run db:migrate
yarn db:migrate
bun run db:migrate

更新后测试

更新后,彻底测试您的应用程序:

  1. 运行开发服务器:
pnpm run dev
npm run dev
yarn dev
bun run dev
  1. 检查控制台错误
  2. 测试关键用户流程
  3. 运行代码检查和格式化:
pnpm run lint
pnpm run format
npm run lint
npm run format
yarn lint
yarn format
bun run lint
bun run format
  1. 检查构建:
pnpm run build
npm run build
yarn build
bun run build

接收更新通知

要接收 MkSaaS 的更新通知:

  1. 关注 GitHub 仓库
  2. 定期查看路线图
  3. 加入 Discord 社区
  4. Twitter/X 和其他社交平台上关注 MkSaaS

视频教程

下一步

现在您了解了如何保持您的 MkSaaS 项目最新,探索这些相关主题: