MCC - Implementación CI/CD con Github Actions

De MCC™ Wiki

Pipeline para GitHub Actions: Build y Push de Imágenes Docker Multi-arch

Creación del pipeline para GitHub Actions, que realiza las pruebas de HTML, construye la imagen Docker usando docker buildx para plataformas AMD64 y ARM64, y la publica en Docker Hub.

1. Pre-requisitos

Tener configuradas tus credenciales de Docker Hub en los Secrets de GitHub:

  • DOCKER_HUB_USERNAME: Tu nombre de usuario de Docker Hub.
  • DOCKER_HUB_PASSWORD: Tu contraseña o token de Docker Hub.
  • DOCKER_HUB_REPO: Nombre del repositorio en Docker Hub (por ejemplo: miusuario/mirepositorio).

Puedes agregar estos secrets desde tu repositorio en GitHub, navegando a Settings > Secrets and variables > Actions y añadiéndolos ahí.

2. Configuración de GitHub Actions (.github/workflows/docker_build.yml)

name: Build and Push Docker Image

on:
  push:
    branches:
      - main  # Ejecutar en la rama principal
  pull_request:
    branches:
      - main

jobs:
  # Validación de HTML
  html_validation:
    runs-on: ubuntu-latest
    steps:
      - name: Check out the code
        uses: actions/checkout@v3

      - name: Set up HTMLHint
        run: |
          sudo apt-get update
          sudo apt-get install -y npm
          npm install -g htmlhint

      - name: Validate HTML files
        run: htmlhint public-html/**/*.html  # Cambia la ruta según tu estructura

  # Construcción y subida de la imagen Docker multi-arch
  docker_build:
    needs: html_validation
    runs-on: ubuntu-latest
    steps:
      - name: Check out the code
        uses: actions/checkout@v3

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2

      - name: Log in to Docker Hub
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKER_HUB_USERNAME }}
          password: ${{ secrets.DOCKER_HUB_PASSWORD }}

      - name: Build and push Docker image (AMD64, ARM64)
        run: |
          docker buildx create --use
          docker buildx inspect --bootstrap
          docker buildx build --platform linux/amd64,linux/arm64 -t ${{ secrets.DOCKER_HUB_REPO }}:latest --push .

Explicación

  • Trigger: El workflow se ejecuta cuando hay un push a la rama principal o cuando se abre un pull request a esa rama.
  • html_validation Job:
    • Usa Node.js para instalar htmlhint y validar los archivos HTML ubicados en la carpeta public-html.
    • Este job se ejecuta primero, y si falla, el pipeline se detiene.
  • docker_build Job:
    • Se ejecuta solo si el job de validación HTML pasa.
    • Usa docker buildx para construir la imagen Docker para ambas arquitecturas (AMD64 y ARM64).
    • Publica la imagen directamente en Docker Hub usando --push.
  • docker_push Job (opcional):
    • Este paso verifica que la imagen se haya subido correctamente a Docker Hub haciendo un docker pull de la imagen recién subida.

3. Ajustes Adicionales

  • Validación de HTML: Puedes ajustar el comando de htmlhint según la estructura de tu proyecto.
  • Tags en Docker: Puedes usar tags de versión o basados en commits en lugar de latest.

4. Configuración de Secrets en GitHub

Ve a Settings > Secrets and variables > Actions en tu repositorio y añade:

  • DOCKER_HUB_USERNAME: Tu usuario de Docker Hub.
  • DOCKER_HUB_PASSWORD: Tu token o contraseña de Docker Hub.
  • DOCKER_HUB_REPO: El nombre del repositorio en Docker Hub, como miusuario/mirepositorio.

Este pipeline te permite realizar pruebas en el HTML, construir imágenes Docker multi-arch y publicarlas en Docker Hub de manera automatizada con GitHub Actions.