SuperAPI AI 工具集

enterprise-submodule

编程与开发

查看项目

更新于 11-06 03:07

技能介绍

用途

该技能适用于修改 Novu 企业版子模块(.source/)或企业包(enterprise/packages/*)的场景,也用于企业子模块需要初始化或更新时。Novu 在 .source 处使用指向 git@github.com:novuhq/packages-enterprise.git 的 git 子模块,enterprise/packages/ 中的企业包其 src 目录以符号链接方式指向 .source/<package>/src。

初始设置

首先为子模块递归配置 git:

git config --global submodule.recurse true

然后初始化子模块:

git submodule update --init --recursive

若 SSH 不可用(如云环境),配置 HTTPS 回退:

git config --global url."https://github.com/".insteadOf "git@github.com:" gh auth setup-git

接着在 apps/api/src/.env 和 apps/worker/src/.env 中添加企业环境变量:

NOVU_ENTERPRISE=true

最后以企业模式安装并构建:

pnpm install:with-ee pnpm build

其中 install:with-ee 会先执行 pnpm install,再执行 pnpm symlink:submodules,将 .source/ 下的 src 目录符号链接到 enterprise/packages/。

拉取变更

在主仓库执行 git pull(当 submodule.recurse=true 时,子模块变更会被获取但不会被合并)。若要在子模块中开发:

cd .source && git checkout <branch> && git pull

在子模块中进行修改

  1. 从两个仓库分别拉取最新代码。
  2. 在主仓库和子模块中创建同名分支,命名遵循 Conventional Commits(例如 feat/scope-description-fixes-NOV-123)。应从子模块中的分支开始,而非 detached HEAD。
  3. 实现修改。
  4. 先在子模块提交,再在主仓库提交。
  5. 在 .source/ 内推送子模块分支:git push
  6. 从工作区根目录创建企业 PR(不要 cd 进入子模块):

gh pr create --repo novuhq/packages-enterprise --head <branch-name> --base next --title "..." --body "..."

若因权限失败,可提供以下链接:

https://github.com/novuhq/packages-enterprise/compare/next...<branch-name>

  1. 推送主仓库分支并用 gh pr create 创建其 PR。
  2. 交叉关联两个 PR:每个 PR 正文链接另一个(monorepo ↔ enterprise);第二个 URL 生成后,通过 gh pr edit 更新较早创建的那个。
  3. 先合并子模块 PR,再合并主仓库 PR,以避免给队友造成构建中断。

故障排查

-** fatal: could not get a repository handle for submodule '.source':删除 .git/modules/ 内容,然后运行 git submodule update --init --recursive。

  • 检出时出现未跟踪工作树文件错误:先执行 git submodule deinit -f enterprise,再检出分支并拉取,然后执行 git submodule update --init --recursive。
  • 终极方案:执行

pnpm run clean rm -rf node_modules pnpm i pnpm run symlink:submodules pnpm nx run-many --target=build --all --skip-nx-cache

关键要点

  • .source 目录包含实际的企业源代码(私有仓库)。
  • enterprise/packages/*/src 是指向 .source/*/src 的符号链接。
  • 企业包包括:@novu/ee-auth、@novu/ee-api、@novu/ee-dal、@novu/ee-billing、@novu/ee-translation、@novu/ee-shared-services。
  • 每个企业包中的 check-ee.mjs 脚本仅在 src 文件夹存在时才构建(为开源贡献者提供优雅降级)。