polinchw/hello-github-webhook

示例应用 Docker 镜像文档

镜像概述

本镜像为示例应用，核心功能是展示如何通过 Github Actions 实现 Docker 镜像的自动化构建，并将构建完成的镜像推送到 Docker Hub 仓库。旨在帮助开发者理解和实践 CI/CD 流程中镜像构建与分发的自动化环节。

核心功能与特性

• 自动化构建：集成 Github Actions 工作流，实现代码提交后自动触发镜像构建流程
• 镜像推送：支持将构建完成的 Docker 镜像自动推送到 Docker Hub 仓库
• 流程演示：提供完整的 CI/CD 配置示例，可作为基础模板进行扩展
• 简单易用：配置步骤清晰，适合新手学习和实践 Docker 镜像的自动化管理

使用场景与适用范围

• 学习场景：开发者学习如何使用 Github Actions 实现 Docker 镜像的自动化构建与推送
• 演示场景：团队内部演示 CI/CD 流程中镜像管理的自动化实现方式
• 基础模板：作为项目集成 Docker 镜像自动化构建流程的基础参考模板

使用方法与配置说明

前置条件

• 拥有 Github 账号及代码仓库
• 拥有 Docker Hub 账号及可推送的仓库
• 在 Github 仓库中配置 Docker Hub 访问凭证（DOCKER_HUB_USERNAME 和 DOCKER_HUB_ACCESS_TOKEN）

配置步骤

1. 创建 Github Actions 工作流文件
   在项目根目录下创建 .github/workflows/docker-build-push.yml 文件，内容示例如下：

   yaml
   name: Build and Push Docker Image
   
   on:
     push:
       branches: [ main ]  # 触发构建的分支
   
   jobs:
     build:
       runs-on: ubuntu-latest
       steps:
         - name: Checkout code
           uses: actions/checkout@v4
   
         - name: Set up Docker Buildx
           uses: docker/setup-buildx-action@v3
   
         - name: Login to Docker Hub
           uses: docker/login-action@v3
           with:
             username: ${{ secrets.DOCKER_HUB_USERNAME }}
             password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
   
         - name: Build and push
           uses: docker/build-push-action@v5
           with:
             context: .
             push: true
             tags: ${{ secrets.DOCKER_HUB_USERNAME }}/sample-app:latest  # 镜像标签
   

2. 配置 Docker Hub 凭证
   在 Github 仓库的 Settings > Secrets and variables > Actions 中添加以下 secrets：

   • DOCKER_HUB_USERNAME: Docker Hub 用户名
   • DOCKER_HUB_ACCESS_TOKEN: Docker Hub 访问令牌（在 Docker Hub 的账号设置中生成）

3. 触发构建流程
   提交代码到配置的触发分支（如示例中的 main 分支），Github Actions 将自动执行镜像构建并推送到 Docker Hub。

镜像使用

构建完成后，可从 Docker Hub 拉取镜像并运行：

bash
docker pull docker.xuanyuan.run/<your-docker-hub-username>/sample-app:latest
docker run -d --name sample-app docker.xuanyuan.run/<your-docker-hub-username>/sample-app:latest

注意事项

• 确保 Dockerfile 存在于项目根目录，且配置正确
• 访问令牌需具备 Docker Hub 仓库的写入权限
• 可根据实际需求调整工作流文件中的触发条件（如分支、事件类型）和镜像标签