如何將帶有 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動作。