Backstage容器部署inventory-backend插件migrations目录报错求助

问题描述 #

开发的inventory-backend Backstage插件包含Knex migrations目录，本地运行正常。按照官方文档构建Docker镜像并部署PostgreSQL后，容器启动时提示找不到/app/plugins/inventory-backend/migrations目录。手动添加COPY指令将该目录复制到容器后，目录可见但报错依旧。

问题根源 #

1. Backstage后端构建默认只打包插件的src目录，migrations目录不会被自动包含到生产bundle中
2. 后端运行时实际从packages/backend/dist加载插件代码，而非容器里手动复制的/app/plugins源码目录
3. Knex配置的migrations路径可能是源码相对路径，和Docker容器内的实际运行路径不匹配

解决方案 #

1. 让插件构建时自动包含Migrations目录 #

在plugins/inventory-backend/package.json里添加files字段，明确指定要打包migrations目录：

{
  "name": "@internal/plugin-inventory-backend",
  // 其他配置不变
  "files": [
    "dist",
    "migrations"
  ]
}

如果你的migrations是用TypeScript写的，还要修改插件的tsconfig.json，把migrations目录加入编译范围：

{
  "extends": "@backstage/cli/config/tsconfig.json",
  "include": [
    "src",
    "migrations"
  ]
}

执行后端重新构建：

yarn build:backend

2. 调整Dockerfile，把Migrations放到正确的位置 #

修改Dockerfile，在解压后端bundle之后，把migrations目录复制到后端插件的dist目录下（这才是后端实际读取的路径）：

# 原有步骤保持不变
COPY --chown=node:node packages/backend/dist/bundle.tar.gz app-config*.yaml ./
RUN tar xzf bundle.tar.gz && rm bundle.tar.gz

# 新增：复制inventory-backend的migrations到后端插件的dist目录
COPY --chown=node:node plugins/inventory-backend/migrations ./packages/backend/dist/plugins/inventory-backend/migrations

CMD ["node", "packages/backend", "--config", "app-config.yaml"]

3. 修正Knex的Migrations路径配置 #

在插件代码里，用绝对路径来指定migrations目录，避免相对路径在Docker里出错：

import { resolve } from 'path';

const knexInstance = Knex({
  // 数据库连接配置不变
  migrations: {
    directory: resolve(__dirname, '../migrations'), // 根据你的插件目录结构调整层级
    extension: 'ts' // 如果是JS迁移文件就改成'js'
  }
});

4. 验证构建结果 #

构建后端后，检查packages/backend/dist/plugins/inventory-backend目录下是否存在migrations文件夹，确认文件已被正确打包进去。

验证步骤 #

1. 重新构建Docker镜像：yarn build-image
2. 启动容器后，进入容器检查/app/packages/backend/dist/plugins/inventory-backend/migrations是否存在
3. 查看容器日志，确认不再出现找不到migrations目录的错误

内容的提问来源于stack exchange，提问作者ahmetuten