InvalidDefinitionDescription

メモ
本チェックは試験的であり、デフォルトでは無効となっています。これを有効にする方法は試験的チェックを参照してください。

出力

Comment for build stage or argument should follow the format: `# <arg/stage name> <description>`. If this is not intended to be a description comment, add an empty line or comment between the instruction and the comment.

(訳：ビルドステージや引数に対するコメントは # <引数/ステージ名> <内容説明> という書式に従う必要があります。説明書きを意図するコメントではない場合は、命令とコメントの間に、空行または空のコメント行を入れてください)

内容説明

docker build コマンドの --call=outline や --call=targets フラグは、ビルドターゲットや引数についての説明を出力します。その説明は Dockerfile コメントから生成されるものです。そして FROM や ARG 命令の直前に記述され、その内容はビルドステージまたは引数の名前から書き始めるものです。たとえば以下のとおりです。

# build-cli CLI バイナリをビルドします。
FROM alpine AS build-cli
# VERSION プログラムバージョンを決定します。
ARG VERSION=1

直前のコメントが説明を行う意図がないものである場合、命令とそのコメントとの間には空行または空コメント行を加えてください。

例

❌ 不可: 説明を意図していないコメントが FROM コマンドの直前行に記述されています。

# 説明を意図していないコメント
FROM scratch AS base

# 説明を意図していない別のコメント
ARG VERSION=1

✅ Good: 説明を意図していないコメントが空行をはさんで記述されています。

# 説明を意図していないコメント

FROM scratch AS base

# 説明を意図していない別のコメント

ARG VERSION=1

✅ Good: ARG キーやステージを説明するコメントがコマンドの直前に記述されています。

# base ソースコンパイルを行うステージです。
FROM scratch AS base
# VERSION これがバージョン番号です。
ARG VERSION=1