减少 Docker 构建警告

以下是消除 Dockerfile 构建中可能出现的警告的一些技巧。

debconf：延迟包配置，因为 apt-utils 未安装

此错误通常可以安全忽略，并且难以完全消除。但是，您可以通过在 Dockerfile 中添加以下内容，将其减少到在安装所需包时在 stdout 中显示一条消息

RUN apt-get update \
    && export DEBIAN_FRONTEND=noninteractive \
    && apt-get -y install --no-install-recommends apt-utils dialog 2>&1

警告：不应解析 apt-key 输出（stdout 不是终端）

此非关键警告告诉您不要解析 apt-key 的输出，因此只要您的脚本不解析，就没有问题。您可以安全地忽略它。

这发生在 Dockerfile 中，因为 apt-key 命令不是从终端运行的。不幸的是，此错误无法完全消除，但可以隐藏，除非 apt-key 命令返回非零退出代码（表示失败）。

例如

# (OUT=$(apt-key add - 2>&1) || echo $OUT) will only print the output with non-zero exit code is hit
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | (OUT=$(apt-key add - 2>&1) || echo $OUT)

您还可以设置 APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE 环境变量来抑制警告，但这看起来有点吓人，因此如果您使用它，请务必在您的 Dockerfile 中添加注释

# Suppress an apt-key warning about standard out not being a terminal. Use in this script is safe.
ENV APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE=DontWarn

信息消息以红色显示

某些 CLI 将某些信息（如调试详细信息）输出到标准错误而不是标准输出。这些将在 Visual Studio Code 的终端和输出日志中以红色显示。

如果消息是无害的，您可以通过在命令末尾附加 2>&1 来将命令从标准错误的输出管道传输到标准输出。

例如

RUN apt-get -y install --no-install-recommends apt-utils dialog 2>&1

如果命令失败，您仍然可以看到错误，但它们不会以红色显示。

避免使用 Docker 构建的镜像出现的问题

鉴于 Dockerfile 和 Docker Compose 文件可以在没有 VS Code 或 devcontainer CLI 的情况下使用，您可能希望让用户知道，如果图像无法按预期工作，他们不应尝试直接构建图像。为了解决此问题，您可以添加一个构建参数，该参数需要指定才能使一切正常工作。

例如，您可以在 Dockerfile 中添加以下内容

ARG vscode
RUN if [[ -z "$devcontainercli" ]] ; then printf "\nERROR: This Dockerfile needs to be built with VS Code !" && exit 1; else printf "VS Code is detected: $devcontainercli"; fi

以及在 devcontainer.json 中添加以下内容

"build": {
      "dockerfile": "Dockerfile",
      "args": {
          // set devcontainer-cli arg for Dockerfile
          "devcontainercli": "true"
      },
    }

在 Docker Compose 案例中，您可以将此参数添加到一个单独的 覆盖文件以扩展您的配置，该文件位于您的源代码树中与主要 Docker Compose 文件不同的位置。