jerray/publish-docker-action

Publish Docker Action镜像说明

镜像概述

Publish Docker Action是一款GitHub Action镜像，旨在简化Docker镜像的构建、打标签与发布流程，支持灵活的配置选项，适配不同的Docker仓库和标签管理需求，帮助开发者高效完成CI/CD中的镜像发布环节。

核心功能

1. 镜像构建：支持指定自定义Dockerfile路径和构建上下文；
2. 标签管理：提供静态标签列表（多标签用逗号分隔）和自动标签生成（基于分支、PR、语义化版本标签）；
3. 仓库配置：可自定义Docker registry地址和repository名称；
4. 缓存加速：支持使用缓存镜像提升构建效率。

使用场景

1. GitHub CI/CD流水线中自动构建并发布Docker镜像；
2. 多环境部署时生成对应环境标签的镜像（如dev、test、prod）；
3. 基于Git语义化版本标签自动生成多版本镜像（如1.0、1.0.0）；
4. PR验证时生成临时镜像用于测试。

配置说明

基础使用示例

使用工作区默认Dockerfile构建镜像，打latest标签并推送到docker.io仓库：

yaml
- uses: jerray/publish-docker-action@master
  with:
    username: ${{ secrets.DOCKER_USERNAME }}
    password: ${{ secrets.DOCKER_PASSWORD }}

自定义构建文件与上下文

通过file和path参数指定非默认的Dockerfile路径和构建上下文：

yaml
- uses: jerray/publish-docker-action@master
  with:
    username: ${{ secrets.DOCKER_USERNAME }}
    password: ${{ secrets.DOCKER_PASSWORD }}
    file: ./docker/Dockerfile.prod
    path: ./app

自定义仓库与标签

指定registry和repository，并设置静态标签列表：

yaml
- uses: jerray/publish-docker-action@master
  with:
    username: ${{ secrets.DOCKER_USERNAME }}
    password: ${{ secrets.DOCKER_PASSWORD }}
    registry: docker.pkg.github.com
    repository: jerray/publish-docker-action
    tags: latest,1.0.0,stable

自动标签生成

开启自动标签功能，基于Git refs类型生成对应标签：

yaml
- uses: jerray/publish-docker-action@master
  with:
    username: ${{ secrets.DOCKER_USERNAME }}
    password: ${{ secrets.DOCKER_PASSWORD }}
    registry: docker.pkg.github.com
    repository: jerray/publish-docker-action
    auto_tag: true
    allow_pull_request: true # 允许PR生成临时标签

自动标签规则：

• 分支：使用分支名（master分支转为latest）；
• PR：添加pr-前缀（如pr-feature-branch）；
• 标签：语义化版本生成多标签（如v1.0.0生成1、1.0、1.0.0），非语义化版本直接使用标签名。

缓存配置

启用缓存加速构建：

yaml
- uses: jerray/publish-docker-action@master
  with:
    username: ${{ secrets.DOCKER_USERNAME }}
    password: ${{ secrets.DOCKER_PASSWORD }}
    cache: true