Dockerhub仓库描述

Question

有人知道dockerhub是如何管理自动构建存储库的描述的吗？

码头枢纽有一个很好的特性，就是将源存储库中的README.md作为存储库描述。实际上，存储库的描述并不总是来自主分支的最新README.md。这似乎是相当随机或相关的最新版本。

实例库：

• /
• Dockerfile
• README.md

分支机构：

• 主控

标签：

• V1.0
• V1.1
• V2.0
• V2.1

现在的问题是:如果我将所有标记都放在Autobuild上，那么存储库描述中将显示哪个README.md是不可复制的。

它有什么窍门吗?还是有一个API可以用来设置描述？

我的愿望是总是显示我的主人/README.md的最新承诺！

Answer 1

DockerHub文档提到：

生成过程在与您的README.md Dockerfile.相同的目录中查找。

(例如见tombatossals/dockerhub/nodejs)

如果存储库中有一个README.md文件，则在存储库中使用它作为完整的描述。 如果在生成后更改完整说明，则将在下次运行自动生成时覆盖该说明。 若要进行更改，请修改Git存储库中的README.md。

注意，正如这里提到的 by 安迪一样，这并不适用于手动构建。

对于手动构建(在这里，您推送自己的映像)，Docker Hub不会窥探您的映像，也无法了解您的自述文件。 您需要手动将Readme文本添加到Information部分。

“任择议定书”要求：

是否有API调用，我可以在其中设置回购的描述？

据我所知(码头1.8+中废弃的码头集线器API)

第467期报告了同样的不确定性：

有时，自动构建系统仍将使用顶级README文件。

第402期报告说：

“每隔一段时间，完整描述和Dockerfile页面中的内容将来自旧的发布标记。”

然后：

“提取README的规范改变了吗?它现在从源存储库获取顶级README，而不是从指定Dockerfile的目录中获取；考虑到通用用例是Dockerfile的存储库，这完全扰乱了文档。”

第300期证实：

我注意到这里有两个明显的缺点：

• a)在Dockerfile所在的子目录中不尊重README.md。
• ( b)即使README.md位于repoository的顶层(以及Dockerfile)，“有时”它也没有被读取，描述也是空白的；即使在强制推进到底层存储库之后。

Answer 2

码头枢纽-描述 GitHub操作可以从README.md文件中更新README.md集线器描述。

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

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

    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插件，它向Docker：docker pushrm添加了一个新命令(for: push readme)。要更新Dockerhub上的自述文件，请运行：

docker pushrm my-user/my-repo

它使用保存的Docker登录名，因此它在docker login之后“工作”。它还支持其他集装箱注册中心(码头、港口)。

对于CI使用，它也可以作为一个码头集装箱和github行动。

如果您正在寻找一个技术上的答案，请查看代码 of docker-pushrm。简而言之:您需要使用用户名/密码获取JWT令牌发出REST请求。然后使用JWT令牌向更新回购信息发出另一个REST请求。