Allure Report Action

A GitHub Action that integrates Allure Report 3 directly into your pull request workflow by posting comprehensive test summaries as comments.

Features

This action automatically analyzes your Allure Report data and creates rich PR comments containing:

• Test Statistics: Complete breakdown of test results including passed, failed, broken, skipped, and unknown tests
• Visual Indicators: Pie charts and status icons for quick visual assessment
• Special Test Categories: Identification of new tests, flaky tests, and retry attempts
• Clickable Counts: When a remote-href is configured (or a remoteHref is present in your summary.json), the New / Flaky / Retry numbers in the summary table become links that open the hosted report pre-filtered to that category
• Collapsible Section Comments: Opt-in per-category comments (sections: new,flaky,retry or sections: all) that list the individual tests in each category inside a collapsible <details> block, posted alongside the summary table. Stale section comments are cleaned up automatically when the underlying category becomes empty
• Multi-Environment Quality Gates: Supports both the legacy flat-array quality-gate format and the newer environment-keyed object format ({ "prod": [...], "staging": [...] })
• Remote Report Integration: Automatic linking to Allure Service hosted reports when configured
• Quality Gate Validation: Creates GitHub check runs based on quality gate results

Quick Start

Prerequisites

Ensure your workflow has the necessary permissions:

permissions:
  pull-requests: write
  checks: write

Basic Setup

Add this action to your workflow after your test execution step:

- name: Execute test suite
  run: |
    # Your test commands that generate Allure Report data

- name: Post Allure Report Summary
  uses: step-security/allure-report-action@v1
  with:
    report-directory: "./allure-report"
    github-token: ${{ secrets.GITHUB_TOKEN }}

Configuration Options

Inputs

Input	Description	Required	Default
report-directory	Directory path containing Allure Report data	No	./allure-report
remote-href	Base URL where the published Allure report is hosted (e.g. GitHub Pages). Used to render View links and per-summary links in the PR comment.	No	""
github-token	GitHub token for PR comment operations	No	${{ github.token }}
sections	Optional collapsible section comments to publish alongside the summary table. Supported values: new, flaky, retry, or all. Accepts comma- or newline-separated values.	No	""

Allure Configuration

This action reads configuration from your allurerc.js or allurerc.mjs file. The output field specifies where to look for generated reports.

Example Configuration

import { defineConfig } from "allure";

export default defineConfig({
  output: "allure-report",
});

Remote Report Integration

To enable automatic linking to reports hosted on Allure Service, add the allureService configuration:

import { defineConfig } from "allure";
import { env } from "node:process";

export default defineConfig({
  output: "allure-report",
  allureService: {
    url: env.ALLURE_SERVICE_URL,
    project: env.ALLURE_SERVICE_PROJECT,
    accessToken: env.ALLURE_SERVICE_ACCESS_TOKEN,
  }
});

Example Workflow

name: Test Suite with Allure Report

on:
  pull_request:
    branches: [ main ]

permissions:
  pull-requests: write
  checks: write

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6

      - name: Setup test environment
        run: |
          # Setup commands

      - name: Run tests
        run: |
          # Test execution that generates Allure data

      - name: Generate Allure Report
        run: |
          # Generate report command

      - name: Post Allure Summary
        uses: step-security/allure-report-action@v1
        with:
          report-directory: "./allure-report"
          github-token: ${{ secrets.GITHUB_TOKEN }}

How It Works

1. Scans Report Directory: The action searches for summary.json files in the specified directory
2. Parses Test Data: Reads and processes all discovered summary files
3. Resolves Per-Summary Remote Links: For each summary.json, derives a hosted-report URL. If remote-href is set and an index.html sits next to the summary, the relative subdirectory is appended so each report row points at its own published page
4. Quality Gate Check: If quality-gate.json exists, creates a GitHub check run with validation results (handles both array and environment-keyed object formats)
5. Creates PR Comment: Generates a markdown table with test statistics and posts it to the pull request. New / Flaky / Retry cells become filter-links when a remote URL is available
6. Posts Section Comments: For each section requested via the sections input that has at least one matching test, posts an additional collapsible comment listing those tests. Each section comment carries a unique marker per (section, summary) pair so it can be updated in place on subsequent runs
7. Cleans Up Stale Sections: Section comments from previous runs whose category is now empty (or no longer requested) are deleted to keep the PR tidy
8. Updates Existing Comments: Uses unique markers to update existing comments instead of creating duplicates

Output Example

The action creates a comment in your pull request similar to this:

	Name	Duration	Stats	New	Flaky	Retry	Report
🥧	Test Suite	2m 30s	✅ 45 ❌ 2 ⚠️ 1 ⏭️ 3	5	2	1	View

Development

Building

npm install
npm run build

Testing

npm test

Local Testing

npm run dev

License

MIT License - See LICENSE file for details

Resources

• Allure Report Documentation
• GitHub Actions Documentation