[docker compose] 複数のcommandをちょっとかっこよく書く方法

Tech

※ 本記事はアフィリエイト広告(Amazonアソシエイト)を含みます。

[docker compose] 複数のcommandをちょっとかっこよく書く方法

少し前までは docker-compose up -d とか書いてたけど、Docker のバージョンが上がったので docker compose up -d で動くようになった。

のと、同時期に

command: >
  /bin/sh -c "command1 \
  && command2"

とか頭に && 入れるとエラーが出るようになった。

(この回避は後ろに持っていけばOK)

だけど、もう少しキレイにしたい。

結論: | で書く

command: |
  sh -c
  "command1 &&
  command2"

これでいい。

&& を行末に置いておけば、シェルは「続きがある」と解釈して次の行をつなげてくれます。行頭に && を置く書き方は、改行の扱い次第でシェルが行の区切りと解釈してしまい、構文エラーになりがちです。

| と > の違い

YAML の複数行文字列には2種類あります。ここを押さえておくとハマりにくい。

記号名前改行の扱い
|literal(リテラル)改行をそのまま残す
>folded(折りたたみ)改行をスペースに置き換えて1行にする

> で書いて行末に \ を置くと、「YAML の折りたたみ」と「シェルの行継続」が二重にかかって、意図しない文字列になりやすいです。改行はシェルに任せる = | を使う、と決めておくと迷いません。

もっとキレイに: リスト形式

さらにキレイに書くなら、リスト形式で sh -c に渡す方法もあります。

command:
  - sh
  - -c
  - |
    command1
    command2

sh と -c を配列で渡しているので、クォートの対応を気にしなくてよくなります。ただし、この書き方だと command1 が失敗しても command2 が実行されます。失敗したら止めたいなら、先頭に set -e を入れるか、&& でつなぎます。

command:
  - sh
  - -c
  - |
    set -e
    npm ci
    npm run dev

長くなってきたらスクリプトに逃がす

3〜4行を超えてきたら、compose ファイルに書き続けるより、シェルスクリプトにしてしまった方が読みやすいです。

command: ["sh", "/app/docker/start.sh"]

スクリプト側なら、コメントも書けるし、単体で動作確認もできます。

まとめ

書き方向いているケース
| + sh -c "..."2〜3個のコマンドをつなぐ
リスト形式 + |クォート地獄を避けたい。set -e で失敗時に止める
スクリプトに分離処理が長い・条件分岐がある

&& は行末に置く。これだけ覚えておけば、だいたい事故りません。

docker-compose