peterevans/dockerhub-description Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

Docker Hub Description

概述和主要用途

Docker Hub Description是一个GitHub Action，用于从GitHub仓库的README.md文件更新Docker Hub仓库描述。对于使用docker push将镜像推送到Docker Hub的用户，此工具提供了一种简单、自动化的方式，保持Docker Hub仓库描述与GitHub仓库README.md文件同步。

核心功能和特性

• 从GitHub仓库的README.md自动更新Docker Hub仓库描述
• 支持指定非根目录的README.md文件路径
• 可将GitHub仓库描述作为Docker Hub仓库的简短描述
• 提供相对URL补全为绝对URL的功能
• 自动处理Docker Hub内容长度限制（描述限25,000字节，简短描述限100字节），超出时截断并在运行日志中发出警告

使用场景和适用范围

• 适用于需要将镜像推送到Docker Hub的开发者和团队
• 希望保持Docker Hub仓库文档与GitHub项目文档一致的场景
• 需要通过自动化流程维护Docker Hub仓库描述的CI/CD工作流

使用方法和配置说明

基本用法

yml
    - uses: actions/checkout@v4

    - name: Docker Hub Description
      uses: peter-evans/dockerhub-description@v5
      with:
        username: ${{ secrets.DOCKERHUB_USERNAME }}
        password: ${{ secrets.DOCKERHUB_PASSWORD }}
        repository: peterevans/dockerhub-description

Action输入参数

指定README文件路径

该Action默认查找仓库根目录下名为README.md的文件。如果README文件位于其他位置，可通过readme-filepath参数指定路径：

yml
    - name: Docker Hub Description
      uses: peter-evans/dockerhub-description@v5
      with:
        username: ${{ secrets.DOCKERHUB_USERNAME }}
        password: ${{ secrets.DOCKERHUB_PASSWORD }}
        repository: peterevans/dockerhub-description
        readme-filepath: ./path/to/README.md

使用GitHub仓库描述作为简短描述

可通过事件上下文将GitHub仓库描述用作Docker Hub的short-description：

yml
    - name: Docker Hub Description
      uses: peter-evans/dockerhub-description@v5
      with:
        username: ${{ secrets.DOCKERHUB_USERNAME }}
        password: ${{ secrets.DOCKERHUB_PASSWORD }}
        repository: peterevans/dockerhub-description
        short-description: ${{ github.event.repository.description }}

示例工作流

当README或工作流文件变更时更新

以下工作流在main分支上的README.md或工作流文件本身发生变更时更新Docker Hub仓库描述。假设工作流文件位于.github/workflows/dockerhub-description.yml。

yml
name: Update Docker Hub Description
on:
  push:
    branches:
      - main
    paths:
      - README.md
      - .github/workflows/dockerhub-description.yml
jobs:
  dockerHubDescription:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Docker Hub Description
      uses: peter-evans/dockerhub-description@v5
      with:
        username: ${{ secrets.DOCKERHUB_USERNAME }}
        password: ${{ secrets.DOCKERHUB_PASSWORD }}
        repository: peterevans/dockerhub-description
        short-description: ${{ github.event.repository.description }}
        enable-url-completion: true

当创建新发布时更新

yml
name: Update Docker Hub Description
on: release
jobs:
  dockerHubDescription:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Docker Hub Description
      uses: peter-evans/dockerhub-description@v5
      with:
        username: ${{ secrets.DOCKERHUB_USERNAME }}
        password: ${{ secrets.DOCKERHUB_PASSWORD }}
        repository: peterevans/dockerhub-description
        short-description: ${{ github.event.repository.description }}

URL补全已知问题

相对URL补全功能存在以下已知问题：

1. 行内代码和代码块中的相对Markdown链接也会被转换：

   markdown
   link in inline code
   

   将被转换为：

   markdown
   link in inline code
   

2. 文本片段中包含方括号（]）的链接不会被转换：

   markdown
   [[link text with square brackets]](#table-of-content)
   

3. 参考式链接/图片不会被转换：

   markdown
   [table-of-content][toc]
   
   ...
   
   [toc]: #table-of-content "Table of content"
   

独立使用Docker镜像（不依赖GitHub Actions）

该镜像可在其他环境中独立于GitHub Actions执行。只需将README.md文件所在位置挂载到容器，并按如下方式设置环境变量：

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

许可证

MIT