Allure notifications

Beautiful test-run notifications — right in your messenger.

Collage PNG + caption with statistics and links. Build config.json in the Config builder, send with the GitHub Action or TypeScript CLI 6.3.2.

GitHub Marketplace Action

Generate the Allure report once, then let the Action render and send the notification:

- uses: qa-guru/allure-notifications@v6
  with:
    config: notifications/config.json
    allure-folder: build/reports/allure-report/allureReport/awesome
    allure-results-folder: build/allure-results
    mode: live
  env:
    TELEGRAM_BOT_TOKEN: ${{ secrets.TELEGRAM_BOT_TOKEN }}
    TELEGRAM_CHAT_ID: ${{ vars.TELEGRAM_CHAT_ID }}
    TELEGRAM_TOPIC_ID: ${{ vars.TELEGRAM_TOPIC_ID }}

Pipeline: tests → allure-results → npx allure generate (once) → Action send. The Action never generates the report and never writes credentials to JSON. See the complete workflow and static config. Runnable Marketplace, native CLI, plugin, and local-Action variants live in .github/workflows/README.md.

Notification example

Zone	Contents
Collage	7 panels: current status · status dynamics · pyramid · durations · success rate · duration dynamics · status transitions
Text	environment, comment, duration, passed / failed / broken / skipped counters
Links	report · dashboard · testops · build from base.links

Omni-tool

(allure-notifications.qa.guru · qa-guru.github.io/allure-notifications)

Missing a messenger or locale? Open an issue or send a PR.

Table of contents

• TypeScript · Quick start
• Config builder (ANB)
• config.json
• Messengers
• Visual canon
• Plugin (alternate)
• Legacy Java 5.0.8
• CI cookbook

TypeScript · Quick start

Version	Stack	Allure	Status
4.*	Java	Allure 2	Historical
5.*	Java	Allure 3	Legacy freeze at 5.0.8 (branch legacy/java-5.0.8); there is no 5.1
6.*	TypeScript	Allure 3	Product — pin 6.3.2 (Action + CLI + builder + plugin)

Older patch notes → GitHub Releases · migration → MIGRATION.md.

Piece	Role
CLI	npx @qa-guru/[email protected] send --config … — primary runtime
Collage PNG	@napi-rs/canvas in @qa-guru/allure-notifications-core (Playwright = tests only)
Config builder	Web UI → full config.json + free-layout collage — apps/builder/
Packages	@qa-guru/allure-notifications-config · core (palette/geometry via @qa-guru/allure-report-kit/collage) · bin allure-notifications · plugin @qa-guru/allure-notifications-plugin

After tests finish, Allure writes a summary. The CLI finds it automatically:

• Allure 2 — <allureFolder>/widgets/summary.json
• Allure 3 — <allureFolder>/summary.json

Summary drives notification text. In collage mode the CLI also reads *-result.json from allureResultsFolder.

npx allure generate allure-results --clean -o allure-report
npx @qa-guru/[email protected] send --config config.json --live

Flag	Behavior
--dry-run	Render collage; list messengers that would send; no network
--mock	Render collage; mock deliveries; no network
--live	Actually send (Telegram when credentials are set)
--out <png>	Write collage PNG to disk

Default without --live / --mock is safe dry-run.

Config builder (ANB)

Web UI that exports a full config.json (base · chart · links · messengers) with a free-layout collage editor.

Prod	allure-notifications.qa.guru
Project Pages	qa-guru.github.io/allure-notifications
Source	apps/builder/
Canon	apps/builder/CANON.md

Install as a PWA (Add to Home Screen / Install) for offline shell and standalone display. On iPad Pro 13″ (landscape):

Canvas presets

Preset	Size	Notes
SQ-1080	1080×1080	Dense square canvas
CB-870	870×1080	Telegram-oriented editor canvas (post cap 1024×1280)
WD-1410	1410×1080	Wide canvas

Export → CLI

1. Arrange panels in the builder → Export / Download config.json.
2. Point base.allureFolder / base.allureResultsFolder at your report and results.
3. Keep messenger credentials empty in JSON and provide them through environment variables.
4. Send:

npx @qa-guru/[email protected] send --config <exported>.json

config.json

Schema: packages/config (zod). Prefer Export from the Config builder.

Minimal 6.0 example — collage + free layout + one messenger:

以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗