Cloud Build で yarn v3 を使いたい

The Node team provides node images that support multiple tagged versions of yarn and additional Node tooling. Please visit https://hub.docker.com/_/node for details.

dockerhub の node image で yarn 使えるからそっちを使えばいいらしい

steps:
- name: 'node'
  entrypoint: 'yarn'
  args: ['install']

dockerhub で node image みてみる。

https://github.com/nodejs/docker-node/blob/9d04fec54bd5f51abe840d7af0c70787b6b32de6/23/alpine3.19/Dockerfile#L80

yarn v1 っぽい？
ってことは、node image だと yarn v3 使えないのか...? 別途 global に install したりする必要があるのか...?

corepack

corepack についてのページを読む。

You may notice by reading our installation guide that we don't tell you to run npm install -g yarn to install Yarn - we even recommend against it. The reason is simple: just like your project dependencies must be locked, so should be the package manager itself.

project 単位で yarn の version も固定したほうが良いよね、とのこと。

Corepack is included with all official Node.js releases starting from Node.js 14.19 / 16.9. It's however opt-in for the duration of the experimental stage, so you'll need to run corepack enable before it's active.

corepack は node に梱包されてるから別途 install する必要はなさげ。ただし enable してあげる必要がある。

corepack enable

https://yarnpkg.com/corepack

corepack enable さえしてあれば、yarn 使えるようになる。
そんで、project ごとに package.json の packageManager の値に応じて yarn の version が利用されるっぽい。

  "packageManager": "yarn@4.5.1"

つまり、node の image で corepack enable してあげれば良さげ。

corepack enable して package.json の指定通りに変わるか

以下の package.json を用意

{
  "name": "corepack-sample",
  "packageManager": "yarn@4.5.1"
}

node image を元に以下を追加した Dockerfile 用意

• corepack enable 実行
• package.json を配置

FROM node:22-alpine

RUN corepack enable

WORKDIR /app

COPY package.json .

docker image build する。

docker build -t corepack-sample .

container 実行して yarn の version 確認

docker run --rm corepack-sample yarn --version

実行結果↓

! Corepack is about to download https://repo.yarnpkg.com/4.5.1/packages/yarnpkg-cli/bin/yarn.js
4.5.1

ちゃんと package.json で指定した version "4.5.1" が利用されている

corepack enable を除外するとどうなるかも確認してく

FROM node:22-alpine

- RUN corepack enable

WORKDIR /app

COPY package.json .

image 再 build して確認。

docker build -t corepack-sample .

docker run --rm corepack-sample yarn --version

実行結果↓

1.22.22

ちゃんと node image で設定されるデフォの yarn version になっているのでOK

build 時に yarn を download させておきたい

! Corepack is about to download https://repo.yarnpkg.com/4.5.1/packages/yarnpkg-cli/bin/yarn.js

上記の例だと、container 実行時に corepack が yarn を download している感がある。image build 時にやっておきたい感。

yarn で何かしらの command が叩かれたタイミングで download してるみたいなので Dockerfile 内で yarn --version を追加しておく。

FROM node:22-alpine

RUN corepack enable

WORKDIR /app

COPY package.json .

+ RUN yarn --version

docker build -t corepack-sample .

docker run --rm corepack-sample yarn --version

実行結果↓

4.5.1

実行後すぐに表示されたので、ちゃんと download 省けたみたい。

Docker image で試す

.yarnrc.yaml, .yarn directory を container 内にコピーした状態で、yarn の versioin が .yarnrc.yaml で指定したものか確認する。

yarnPath: .yarn/releases/yarn-4.5.1.cjs

FROM node:22-alpine

WORKDIR /app

COPY .yarnrc.yml .
COPY .yarn .yarn

docker build -t corepack-sample .

docker run --rm corepack-sample yarn --version

実行結果↓

4.5.1

問題なく .yarnrc.yml で指定された version になっている。
念の為 container 内で app directory とそれ以外で yarn の version 確認。

docker run --rm -it firebase-yarnv3-docker sh        

ちゃんと app directory 外では node image のデフォの v1.22.22 が利用されていることがわかる↓

実行 directory を指定

dir fiield を指定すればOK

Use the dir field in a build step to set a working directory to use when running the step's container. If you set the dir field in the build step, the working directory is set to /workspace/<dir>. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions (unless a volume for that path is specified).

steps:
- name: 'node'
  entrypoint: 'yarn'
  args: ['install']
  dir: 'examples/hello_world'

https://cloud.google.com/build/docs/build-config-file-schema#dir