Allure 3 Reporting Framework

repository·main·Indexed 43 days ago

https://github.com/allure-framework/allure3

A next-generation reporting framework rebuilt in TypeScript featuring a modular plugin system, real-time report monitoring, and a specialized 'Agent' mode for automated/AI-driven workflows. Includes the Allure Query Language (AQL) for programmatic filtering and validation of test data, a CLI for generating and viewing reports, and a dedicated Charts API.

Tokens
203.3K
Snippets
683
Records
848
Agent score
54%

What's inside Allure

  1. Overview of Web Allure Classic

    main

    Web Allure Classic is the internal web implementation of the Allure Classic report. It provides the exact look and functionality of the original Allure Report (Allure 2).

    Note for Users: This specific workspace (web-classic) is used for internal development and is not intended to be installed or used directly by CLI users. For production use, the assets are built and archived into the @allurereport/plugin-classic package.

  2. Overview of the Web Allure Dashboard

    main

    The Web Allure Dashboard is the internal web implementation of the Allure Dashboard report.

    Note for CLI users: This specific workspace (packages/web-dashboard) is not intended to be installed or used directly via the CLI. Instead, its production assets are built and archived into the @allurereport/plugin-dashboard package. If you want to use the dashboard functionality, you should look for the @allurereport/plugin-dashboard package.

  3. Understand Web Allure Awesome report implementation

    main

    Web Allure Awesome is the internal web implementation for Allure Awesome reports.

    Note for users: This workspace is not intended to be installed or published directly by CLI users. Its production assets are built and archived into the @allurereport/plugin-awesome package. To use these report features, you should use the standard Allure CLI or integration methods that include the Awesome plugin.

  4. Understand the role of @allurereport/web-allure2

    main

    The @allurereport/web-allure2 package contains the internal source and build configuration for the Allure 2-compatible report UI.

    Note for CLI users: This workspace is not intended to be installed or published directly. Its production assets are archived into the @allurereport/plugin-allure2 package. If you are an end-user looking to use Allure 2 reports, you should use the plugin rather than this specific workspace.

  5. Upload Test Results and Reports to Jira

    main

    The plugin automatically uploads data during the report generation process if the corresponding flags are set to true in the configuration:

    • Set uploadReport: true to attach the full Allure report to the specified Jira issue.
    • Set uploadResults: true to upload individual test results linked to Jira issues.

    Requirements:

    • The user associated with the token must have edit permissions for the specified issue and any issues linked in your tests.
    • Only issues belonging to the Jira instance specified by the webhook URL will be processed.