lgohr/publish-docker-github-action

概述

该GitHub Action用于将Docker镜像推送到DockerHub，核心功能是自动使用Git分支名称作为Docker镜像标签。通过集成到GitHub CI/CD流程中，可简化镜像推送步骤，实现分支与镜像标签的自动化关联。

特性

• 自动基于Git分支名生成Docker标签，无需手动指定
• 支持自定义标签规则，可覆盖默认分支标签逻辑
• 简化DockerHub认证与推送流程，减少配置复杂度
• 兼容GitHub Actions工作流，易于集成到现有CI/CD管道

使用场景

适用于需要在GitHub仓库中通过CI/CD自动构建并推送Docker镜像至DockerHub的场景。例如：

• 开发分支（如develop）推送至dev标签，用于测试环境部署
• 主分支（如main）推送至latest标签，用于生产环境更新
• 特性分支（如feature/new-ui）推送至对应特性标签，便于分支测试

使用示例

在GitHub工作流文件（如.github/workflows/push-docker.yml）中添加以下配置：

yaml
name: Push Docker Image to DockerHub
on:
  push:
    branches: [ main, develop, 'feature/*' ]
jobs:
  push:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Build and push Docker image
        uses: elgohr/Publish-Docker-Github-Action@v5
        with:
          name: username/my-docker-repo
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}
          # 默认使用当前分支名作为标签，可通过tag参数自定义
          # tag: ${{ github.ref_name }}

参数说明：

• name：DockerHub仓库名（格式：用户名/仓库名）
• username：DockerHub用户名（建议通过GitHub Secrets存储）
• password：DockerHub访问令牌（需在DockerHub生成，通过GitHub Secrets传入）
• tag：可选，自定义标签，默认值为Git分支名（github.ref_name）