Dockerでモノレポのpackage.jsonをいい感じにコピーする（ディレクトリ構造を維持しつつコピーする）

2024/09/06docker

Dockerでモノレポのpackage.jsonをいい感じにコピーする（ディレクトリ構造を維持しつつコピーする）

Dockerについて半日ぐらい調べたときの成果3。COPY --parentsについて。

本題の前に、今回の話と直接関係ないが、別の記事にするほどでもないかなと思い書き残しておく。Dockerにはレイヤという概念があります。これを知るのがDocker初心者から抜け出す第一歩だと思う（逆にこれを知らなかった先週の私は初心者）。
レイヤに関しては公式ドキュメントに記載されているが、日本語の翻訳プロジェクトの記事の方が理解はし易いと思う。ただしこちらはDocker v23の情報だ。

今回の話であるCOPYなんかは特に重要で、例えば COPY . . のあと RUN npm installするより COPY ./package.json ./package.json した後に RUN npm install する方がキャッシュが効いて高速になる。

モノレポ環境でDockerのビルドをしたい時に、yarn install をしたい場合、2つほど問題が発生する。

他パッケージに依存しているときはモノレポのルートでCOPYをする必要がある
yarn install --immutableをする場合は、すべてのモノレポのpackage.jsonが必要

上記を解決するためには、モノレポのルートをビルドコンテキストとして指定する必要がある。そこで各パッケージのpackage.jsonをコピーしたいが、COPY ./packages/*/package.json . のようなコピーの方法は使えない。というのもこれだと./packages/backend/package.jsonを./package.jsonにコピーした後./packages/frontend/package.jsonを./package.jsonにコピーする、という感じの動作になる。つまり、最後にコピーしたpackage.jsonが残る。これを解決するのにはCOPY ./packages/backend/package.json ./packages/backend/package.jsonのように、コピー元とコピー先を指定する必要がある。これだとパッケージが増える度に指定する必要がある。

そこで**COPY --parentsを利用する。これはコピー元の親ディレクトリを保持したままコピーしてくれる**、上記の課題を解決してくれるすぐものだ。

COPY --parents ./packages/*/package.json ./

とやると、./packages/backend/package.jsonを./packages/backend/package.jsonにコピーし、./packages/frontend/package.jsonを./packages/frontend/package.jsonにコピーする、という動作になる。

ドキュメントに記載通りだが、上記はstableな機能ではないため、# syntax=docker/dockerfile:1.7-labsを先頭に扶養する必要がある。