## File: README.md

[license]: http://www.apache.org/licenses/LICENSE-2.0 "Apache License 2.0"
[site]: https://allurereport.org/?source=github_allure2 "Official Website"
[docs]: https://allurereport.org/docs/?source=github_allure2 "Documentation"
[qametaio]: https://qameta.io/?source=Report_GitHub "Qameta Software"
[blog]: https://qameta.io/blog "Qameta Software Blog"
[Twitter]: https://twitter.com/QametaSoftware "Qameta Software"
[twitter-team]: https://twitter.com/QametaSoftware/lists/team/members "Team"
[build]: https://github.com/allure-framework/allure2/actions/workflows/build.yaml
[build-badge]: https://github.com/allure-framework/allure2/actions/workflows/build.yaml/badge.svg
[maven]: https://repo.maven.apache.org/maven2/io/qameta/allure/allure-commandline/ "Maven Central"
[maven-badge]: https://img.shields.io/maven-central/v/io.qameta.allure/allure-commandline.svg?style=flat
[release]: https://github.com/allure-framework/allure2/releases/latest "Latest release"
[release-badge]: https://img.shields.io/github/release/allure-framework/allure2.svg?style=flat
[CONTRIBUTING.md]: .github/CONTRIBUTING.md
[CODE_OF_CONDUCT.md]: CODE_OF_CONDUCT.md

# Allure Report

[](#backers) [](#sponsors)

> 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](https://allurereport.org)
- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) –  stay updated with our latest news and updates
- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action

---

## Download

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

* Grab it from [releases](https://github.com/allure-framework/allure2/releases) (see Assets section).
* Using Homebrew:

    ```bash
    $ brew install allure
    ```
* For Windows, Allure is available from the [Scoop](http://scoop.sh/) commandline-installer.
To install Allure, download and install Scoop and then execute in the Powershell:

    ```bash
    scoop install allure
    ```
## How Allure Report works
    
Allure Report can build unified reports for dozens of testing tools across eleven programming languages on several CI/CD systems. 



## Allure TestOps

[DevOps-ready Testing Platform built][qametaio] 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

This project exists thanks to all the people who contributed. [[Contribute]](.github/CONTRIBUTING.md).

[](https://github.com/allure-framework/allure2/graphs/contributors)

---

## File: plugins/xray-plugin/README.md

# 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

## Allure Screen Diff Plugin

Plugin provides screen diff block

### Configuration

* 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



### Show overlay view

---

## File: plugins/jira-plugin/README.md

# 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](https://marketplace.atlassian.com).

## Export TestResult information

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

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

## Allure Custom Logo Plugin

Plugin changes Allure Logo