allure2 Documentation

File: README.md Copy Chapter

Allure Report

Allure Report is a flexible multi-language test report tool to show you a detailed representation of what has been tested and extract maximum from the everyday execution of tests.

• Learn more about Allure Report at https://allurereport.org
• 📚 Documentation – discover official documentation for Allure Report
• ❓ Questions and Support – get help from the team and community
• 📢 Official announcements – stay updated with our latest news and updates
• 💬 General Discussion – engage in casual conversations, share insights and ideas with the community
• 🖥️ Live Demo — explore a live example of Allure Report in action

Download Copy Chapter

You can use one of the following ways to get Allure:

• Grab it from releases (see Assets section).

• Using Homebrew:

  bash Copy

  $ brew install allure

• For Windows, Allure is available from the Scoop commandline-installer.
  To install Allure, download and install Scoop and then execute in the Powershell:

  bash Copy

  scoop install allure

How Allure Report works Copy Chapter

Allure Report can build unified reports for dozens of testing tools across eleven programming languages on several CI/CD systems.

Allure TestOps Copy Chapter

DevOps-ready Testing Platform built to reduce code time-to-market without quality loss. You can set up your product quality control and boost your QA and development team productivity by setting up your TestOps.

Contributors Copy Chapter

This project exists thanks to all the people who contributed. [Contribute].

File: plugins/xray-plugin/README.md Copy Chapter

Allure Xray Plugin

How it works:

• add tms link in your test cases (for example in java: @TmsLink("XT-1"))
• setup Jira env variables:
  • ALLURE_JIRA_ENDPOINT=https://<jira>/jira/rest/
  • ALLURE_JIRA_USERNAME=
  • ALLURE_JIRA_PASSWORD=
• enable plugin - add env property ALLURE_XRAY_ENABLED=true
• provide execution issue keys - add env property ALLURE_XRAY_EXECUTION_ISSUES=XT-6
• generate report

After that allure update testruns statuses from report:

File: plugins/screen-diff-plugin/README.md Copy Chapter

Allure Screen Diff Plugin Copy Chapter

Plugin provides screen diff block

Configuration Copy Section

• Add label [key='testType', value='screenshotDiff'] to testcase
• Attach to testcase three screenshots:
  • diff.png
  • actual.png
  • expected.png
• Generate allure report

Show diff view Copy Section

Show overlay view Copy Section

File: plugins/jira-plugin/README.md Copy Chapter

Allure Jira Plugin

This plugin requires executor.json file (which automatically generates by Jenkins, TeamCity, Bamboo) in test result directory.
This file contains information about report location for backlinks from Jira.

This plugin requires 'Allure for Jira' plugin installed in your Jira.
You can find it at Atlassian Marketplace.

Export TestResult information Copy Chapter

How it works:

• add issue link in your test cases (for example in java: @Issue("ALLURE-1"))
• enable plugin - add env property ALLURE_JIRA_ENABLED=true
• setup Jira env variables:
  • ALLURE_JIRA_ENDPOINT=https://<jira>/jira/rest/
  • ALLURE_JIRA_USERNAME=
  • ALLURE_JIRA_PASSWORD=
• generate report

After that you will see such panel in Jira issue:

Export Launch information Copy Chapter

How it works:

• enable plugin - add env property ALLURE_JIRA_ENABLED=true
• set issue for launch export - add env property ALLURE_JIRA_LAUNCH_ISSUES=ALLURE-2
• setup Jira env variables:
  • ALLURE_JIRA_ENDPOINT=https://<jira>/jira/rest/
  • ALLURE_JIRA_USERNAME=
  • ALLURE_JIRA_PASSWORD=
• generate report

After that you will see such panel in Jira issue:

File: plugins/custom-logo-plugin/README.md Copy Chapter

Allure Custom Logo Plugin Copy Chapter

Plugin changes Allure Logo