wuhan005/publish-docker-action

Publish Docker Action

镜像概述和主要用途

Publish Docker Action是一个GitHub Action，用于在GitHub Actions工作流中构建、标记并发布Docker镜像到指定的Docker仓库。它简化了镜像构建和发布流程，支持自定义构建配置、仓库设置、标签格式及缓存功能，适用于各类CI/CD场景。

核心功能和特性

• 基于工作区中的Dockerfile默认构建镜像
• 支持自定义构建文件（file参数）和构建上下文（path参数）
• 可指定目标Docker仓库（registry参数）和仓库名称（repository参数）
• 提供自动标签生成功能（auto_tag参数），支持自定义标签格式（tag_format参数）
• 支持使用缓存镜像加速构建过程（cache参数）

使用场景和适用范围

适用于GitHub Actions工作流中需要自动构建并发布Docker镜像的场景，例如：

• CI/CD流程中自动将应用镜像发布到Docker Hub
• 发布镜像到私有Docker仓库或GitHub Packages
• 需要根据时间戳、日期等动态生成镜像标签的场景
• 希望通过缓存加速Docker镜像构建的场景

使用方法和配置说明

基本使用

默认情况下，Action会使用工作区中的Dockerfile构建镜像，附加latest标签，并推送到Docker默认仓库（docker.io），仓库名称默认为GitHub仓库名称。

yaml
- uses: wuhan005/publish-docker-action@master
  with:
    username: ${{ secrets.DOCKER_USERNAME }}  # Docker仓库用户名（通过secrets存储）
    password: ${{ secrets.DOCKER_PASSWORD }}  # Docker仓库密码（通过secrets存储）

自定义构建文件和上下文

如果Dockerfile或构建上下文不在默认工作区目录，可通过file和path参数指定：

yaml
- uses: wuhan005/publish-docker-action@master
  with:
    username: ${{ secrets.DOCKER_USERNAME }}
    password: ${{ secrets.DOCKER_PASSWORD }}
    file: ./path/to/custom/Dockerfile  # 自定义Dockerfile路径
    path: ./build/context  # 自定义构建上下文路径

设置仓库和注册表

通过registry和repository参数可更改目标Docker仓库和仓库名称：

yaml
- uses: wuhan005/publish-docker-action@master
  with:
    username: ${{ secrets.DOCKER_USERNAME }}
    password: ${{ secrets.DOCKER_PASSWORD }}
    registry: docker.pkg.github.com  # 目标Docker注册表（如GitHub Packages）
    repository: jerray/publish-docker-action  # 目标仓库名称（格式：用户名/仓库名）

标签格式配置

当auto_tag设为true时，可通过tag_format自定义镜像标签格式。默认标签格式为"%TIMESTAMP%"（时间戳）。

支持的格式符号：

• %TIMESTAMP%: 时间戳
• %YYYY%: 年份（4位）
• %MM%: 月份（2位）
• %DD%: 日期（2位）
• %H%: 小时（24小时制，2位）
• %m%: 分钟（2位）
• %s%: 秒（2位）

示例：

yaml
- uses: wuhan005/publish-docker-action@master
  with:
    username: ${{ secrets.DOCKER_USERNAME }}
    password: ${{ secrets.DOCKER_PASSWORD }}
    registry: docker.pkg.github.com
    repository: wuhan005/publish-docker-action
    auto_tag: true  # 启用自动标签生成
    tag_format: "foo%YYYY%_%MM%"  # 标签格式：foo+年份+下划线+月份

上述配置将生成类似foo2019_09的镜像标签。

缓存使用

通过cache参数可启用缓存镜像加速构建过程：

yaml
- uses: wuhan005/publish-docker-action@master
  with:
    username: ${{ secrets.DOCKER_USERNAME }}
    password: ${{ secrets.DOCKER_PASSWORD }}
    cache: true  # 启用缓存