如何将带有 README 文件的 docker 镜像推送到 docker hub？

Question

我正在尝试将 docker 映像推送到我在 docker hub 上的私人仓库。 但是，我确实看到 Docker Hub 上有一个“信息”部分，我想用有关我的图像的有用信息更新该部分。 我想知道我是否可以推送一个 README.md 文件，Docker Hub 可以解析这个文件并用它更新“信息”部分。 我不确定是否应该在我的图像中嵌入 README.md 以使其正常工作？

Answer 1

如果您正在执行“自动构建”，Docker Hub 将尝试解析您的Readme.md 。 对于手动构建（在其中推送您自己的镜像），Docker Hub 不会查看您的镜像源代码存储库，也无法了解您的自述文件。 您需要手动将自述文本添加到信息部分

Answer 2

dockerhub-description GitHub Action 可以从 README.md 文件更新 Docker Hub 描述。

    - name: Docker Hub Description
      uses: peter-evans/dockerhub-description@v2
      env:
        DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
        DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
        DOCKERHUB_REPOSITORY: peterevans/dockerhub-description

您还可以在其他 CI 工具中独立于 GitHub Actions 使用它。

    docker run -v $PWD:/workspace \
      -e DOCKERHUB_USERNAME='user1' \
      -e DOCKERHUB_PASSWORD='xxxxx' \
      -e DOCKERHUB_REPOSITORY='my-docker-image' \
      -e README_FILEPATH='/workspace/README.md' \
      peterevans/dockerhub-description:2.1.0

Answer 3

docker-pushrm是一个 Docker CLI 插件，它向 Docker 添加了一个新的docker pushrm （说： push readme ）命令。 安装后，您可以使用以下命令将 README 推送到 Docker Hub、Quay 或 Harbor：

$ ls
README.md
$ docker pushrm my-user/my-repo

它使用来自 Docker 凭证存储的登录信息，因此它“仅适用于”您已经登录的注册表。 我以交互方式和 CI 使用它。 还有一个基于它的github动作。