Allure GitHub Action Allure 3

Allure Report 3 viene con soporte para la Allure GitHub Action.

Con esta acción puedes publicar automáticamente resúmenes de ejecución de pruebas como comentarios en pull requests en tu repositorio de GitHub. Los resúmenes contienen:

• Una tabla visual resumen de la ejecución y los reportes generados
• Duración de la ejecución de pruebas
• Cantidad de pruebas nuevas, inestables y reintentadas en la ejecución
• Enlace al reporte completo, si fue publicado en Allure Service
• Listas detalladas de pruebas nuevas, inestables o reintentadas

Además, si tu configuración de allure incluye ajustes de quality gate, obtendrás una verificación de GitHub Check de Quality Gate (aprobado/fallido) en tus pull requests.

Prerrequisitos

Flujo de Trabajo de Generación de Allure Report

Para funcionar correctamente, esta GitHub Action requiere que tu flujo de trabajo use Allure 3 y las integraciones de Allure relevantes dependiendo de tu framework para generar un Allure Report HTML.

Los reportes HTML producen el archivo {report-directory}/summary.json que la acción lee, convierte en una tabla resumen legible y publica como comentario en el pull request.

TIP

La acción no funcionará completamente si estás generando reportes CSV, ya que el plugin CSV no crea un archivo summary.json. Tampoco puede funcionar con plugins de reporte HTML de terceros, si no crean un summary.json.

Permisos de GitHub

Añade permisos de pull-requests y checks a tu flujo de trabajo para habilitar comentarios y verificaciones para pull requests en tu repositorio:

permissions:
  pull-requests: write
  checks: write

Configuración

Añade la acción a tu flujo de trabajo justo después del paso en el que produces el Allure Report:

- name: Run tests
  run |-
    # ejecuta tus pruebas que generan datos de Allure Report

- name: Run Allure Action
  uses: allure-framework/allure-report@v0
  with:
    # Ruta al directorio del reporte generado
    # Por defecto, está configurado como `./allure-report`
    report-directory: "./allure-report"
    # Token de GitHub que se usa para publicar los comentarios en Pull Requests
    github-token: ${{ secrets.GITHUB_TOKEN }}

Ejemplo Mínimo Funcional

name: Tests with Allure Report

on:
  pull_request:
    branches: [main]

permissions:
  pull-requests: write
  checks: write

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
      # 1. Checkout code
      - name: Checkout
        uses: actions/checkout@v4

      # 2. Setup your language/runtime
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "20"

      # 3. Install dependencies
      - name: Install dependencies
        run: npm ci

      # 4. Run tests (must use Allure reporter)
      - name: Run tests and generate report
        run: npx allure run -- npm run test
        # Esto genera el directorio allure-results/ y crea allure-report/ con summary.json

      # 5. Post summary to PR
      - name: Run Allure Action
        uses: allure-framework/allure-action@v0
        with:
          report-directory: "./allure-report"
          github-token: ${{ secrets.GITHUB_TOKEN }}

Archivo de Configuración de Allure Report

Además de su propia configuración en el archivo de flujo de trabajo, la acción también utiliza el archivo de configuración de runtime de Allure 3 (allurerc.mjs o allurerc.js).

Utiliza el campo output del archivo de configuración como una ruta donde debe buscar los reportes generados. Esto es importante para configuraciones con múltiples reportes.

Salidas

Comentario con Tabla Resumen

La acción publica un comentario como este:

Si tienes múltiples reportes configurados en tu configuración (por ejemplo, un reporte general y un reporte de dashboard), obtendrás una fila de tabla separada para cada reporte.

Listas de Pruebas Individuales

Si se detectan pruebas nuevas, inestables o reintentadas durante la ejecución, la acción publicará comentarios separados listándolas individualmente.

Las listas largas se dividen en fragmentos y se publican como varios comentarios separados para mantenerse dentro del límite de caracteres de comentarios de GitHub.

TIP

Actualmente, para que esta función funcione correctamente, se requiere que rastrees el historial de pruebas entre ejecuciones de flujo de trabajo, ya que el estado de nuevas e inestables se determina según el historial. Sin esto, los conteos de pruebas nuevas e inestables siempre serán 0.

El seguimiento remoto del historial es compatible de forma nativa en Allure Service.

Verificación de Quality Gate

Si los quality gates están configurados en tu configuración de Allure, la acción crea un GitHub Check:

• ✅ Success - Todos los quality gates pasaron
• ❌ Failure - Uno o más quality gates fallaron

La verificación incluye detalles sobre qué reglas fallaron.

Para determinar el resultado, la acción busca datos de quality gate en el archivo {report-directory}/quality-gate.json.