使用 docker 构建 Yarn 工作区

Question

考虑以下纱线工作区的文件结构：

.
├── docker-compose.yaml
├── package.json
├── packages
│   └── pkg-1
│       ├── dist
│       ├── package.json
│       ├── src
│       └── tsconfig.json
├── services
│   ├── api-1
│   │   ├── dist
│   │   ├── Dockerfile
│   │   ├── package.json
│   │   ├── src
│   │   ├── tsconfig.json
│   │   └── yarn.lock
│   └── client-1
│       ├── package.json
│       ├── src
│       └── yarn.lock
├── tsconfig.json
└── yarn.lock

我已经编写了 Dockerfile 来为 api-1 创建镜像：

ARG APP_DIR=/usr/app

# Build stage
FROM node:16.2-alpine AS build

ARG APP_DIR

WORKDIR ${APP_DIR}
COPY package.json ./
COPY yarn.lock ./
COPY tsconfig.json ./

WORKDIR ${APP_DIR}/packages/pkg-1
COPY packages/pkg-1/package.json ./
RUN yarn --pure-lockfile --non-interactive
COPY packages/pkg-1/tsconfig.json ./
COPY packages/pkg-1/src/ ./src
RUN yarn build

WORKDIR ${APP_DIR}/services/api-1
COPY services/api-1/package.json ./
COPY services/api-1/yarn.lock ./
RUN yarn --pure-lockfile --non-interactive
COPY services/api-1/tsconfig.json ./
COPY services/api-1/src/ ./src
RUN yarn build

# Production stage
FROM node:16.2-alpine AS prod

ARG APP_DIR

WORKDIR ${APP_DIR}
COPY --from=build ${APP_DIR}/package.json ./
COPY --from=build ${APP_DIR}/yarn.lock ./

WORKDIR ${APP_DIR}/packages/pkg-1
COPY --from=build ${APP_DIR}/packages/pkg-1/package.json ./
RUN yarn --pure-lockfile --non-interactive --production
COPY --from=build ${APP_DIR}/packages/pkg-1/dist ./dist

WORKDIR ${APP_DIR}/services/api-1
COPY --from=build ${APP_DIR}/services/api-1/package.json ./
COPY --from=build ${APP_DIR}/services/api-1/yarn.lock ./
RUN yarn --pure-lockfile --non-interactive --production
COPY --from=build ${APP_DIR}/services/api-1/dist ./dist

CMD ["node", "dist"]

构建从根 docker-compose.yaml 运行以获得正确的上下文：

services:
  api-1:
    image: project/api-1
    container_name: api-1
    build:
      context: ./
      dockerfile: ./services/api-1/Dockerfile
      target: prod
    ports:
      - 3000:3000

它正在工作，但这样在应用程序增长时会有很多重复。问题在于包的构建方式。

包可以是例如客户端服务之间使用的规范化组件集合或api服务之间使用的规范化错误集合。

每当我要构建一些服务时，我都需要首先构建它的依赖包，这是不必要的重复任务。更不用说各个包的构建步骤在使用该包的每个服务的 Dockerfile 中一遍又一遍地定义。

所以我的问题是。有没有办法创建例如将用于构建服务的包的图像以避免在服务 Dockerfile 中定义包的构建步骤？

Answer 1

似乎您正在寻找可以让您选择拥有“父”package.json 的东西，因此您只需在其中调用“build”并构建整个依赖关系树。

例如：

- package.json // root package
  | - a
    | - package.json // module a package
  | - b
    | - package.json // module b package

您可能需要查看以下内容：

• npm workspaces
• lerna

两种支持结构都像上面提到的那样，lerna 具有更多功能。要快速了解差异，请看这里：Is Lerna needed anymore with NPM 7.0.0's workspaces?

Answer 2

前段时间我发了an answer detailing how I structured a monorepo with multiple services and packages。

“诀窍”是复制您的服务所依赖的所有包，以及项目根 package.json。然后运行yarn --pure-lockfile --non-interactive --production 一次将安装所有子包的依赖项，因为它们是工作区的一部分。

链接的示例没有使用打字稿，但我相信这可以通过在每个运行yarn build 的package.json 中的postinstall 脚本轻松实现。