Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
baev authored Dec 21, 2023
1 parent 2881d11 commit 9130b84
Showing 1 changed file with 30 additions and 44 deletions.
74 changes: 30 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,48 +13,48 @@
[![Build](https://github.com/allure-framework/allure-java/actions/workflows/build.yml/badge.svg)](https://github.com/allure-framework/allure-java/actions/workflows/build.yml)
[![Allure Java](https://img.shields.io/github/release/allure-framework/allure-java.svg)](https://github.com/allure-framework/allure-java/releases/latest)

The repository contains new versions of adaptors for JVM-based test frameworks.
> The repository contains new versions of adaptors for JVM-based test frameworks.
All the artifacts are deployed to `https://repo1.maven.org/maven2/io/qameta/allure/`.
[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")

## TestNG

The new TestNG adaptors is pretty much ready. To use the adaptor you should add the following dependency:
- 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

```xml
<dependency>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-testng</artifactId>
<version>$LATEST_VERSION</version>
</dependency>
```
---
## TestNG

also you need to configure AspectJ weaver to support steps.
- πŸš€ Documentation β€” https://allurereport.org/docs/testng/
- πŸ“š Example project β€” https://github.com/allure-examples?q=topic%3Atestng
- βœ… Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/

## JUnit 4

The first draft of a new JUnit 4 adaptor is ready. To use the adaptor you should add the following dependency:
- πŸš€ Documentation β€” work in progress
- πŸ“š Example project β€” https://github.com/allure-examples?q=topic%3Ajunit4
- βœ… Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/
-
## JUnit 5

```xml
<dependency>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-junit4</artifactId>
<version>$LATEST_VERSION</version>
</dependency>
```
- πŸš€ Documentation β€” https://allurereport.org/docs/junit5/
- πŸ“š Example project β€” https://github.com/allure-examples?q=topic%3Ajunit5
- βœ… Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/

## JUnit 5
## Cucumber JVM

To use JUnit 5 simply add the following dependency to your project:
- πŸš€ Documentation β€” https://allurereport.org/docs/cucumberjvm/
- πŸ“š Example project β€” https://github.com/allure-examples?q=cucumber&type=all&language=java
- βœ… Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/

```xml
<dependency>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-junit5</artifactId>
<version>$LATEST_VERSION</version>
</dependency>
```
## Spock

- πŸš€ Documentation β€” https://allurereport.org/docs/spock/
- πŸ“š Example project β€” https://github.com/allure-examples?q=topic%3Aspock
- βœ… Generate a project in 10 seconds via Allure Start - https://allurereport.org/start/

## Selenide

Listener for Selenide, that logging steps for Allure:
Expand Down Expand Up @@ -240,17 +240,3 @@ Usage example:
Awaitility.setDefaultConditionEvaluationListener(new AllureAwaitilityListener());
```

## Cucumber
4,5,6,7 versions are supported instead of N use the required version.
To use Cucumber simply add the following dependency to your project:

[How to use allure cucumber code examples](https://github.com/allure-examples?q=cucumber&type=all&language=java)

```xml
<dependency>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-cucumberN-jvm</artifactId>
<version>$LATEST_VERSION</version>
</dependency>

```

0 comments on commit 9130b84

Please sign in to comment.