From eb26699e1f487d847b46e652fecf1e0c8785a6e5 Mon Sep 17 00:00:00 2001 From: Maksim Stepanov <17935127+delatrie@users.noreply.github.com> Date: Fri, 29 Mar 2024 00:42:13 +0700 Subject: [PATCH] Update Xunit and NUnit readmes - Add namespace change note to Allure.NUnit - Fix [AllureNUnit]'s namespace - Add header and supported TFMs to Allure.Xunit - Fix supported SpecFlow versions --- Allure.NUnit/README.md | 31 ++++++++++++++++++++++++++++--- Allure.SpecFlow/README.md | 5 +++-- Allure.Xunit/README.md | 26 +++++++++++++++++++++----- 3 files changed, 52 insertions(+), 10 deletions(-) diff --git a/Allure.NUnit/README.md b/Allure.NUnit/README.md index 118b3db2..f8196fdd 100644 --- a/Allure.NUnit/README.md +++ b/Allure.NUnit/README.md @@ -22,9 +22,9 @@ - Install the Allure.NUnit package. - Configure allureConfig.json. -- Apply the `[AllureNUnit]` attribute to test fixtures. -- Use other attributes in `NUnit.Allure.Attributes` if needed. -- Use the functions in `Allure.Net.Commons.AllureApi` if needed. +- Apply the `[Allure.NUnit.AllureNUnit]` attribute to test fixtures. +- Use other attributes from `Allure.NUnit.Attributes` if needed. +- Use the functions from `Allure.Net.Commons.AllureApi` if needed. ## Further readings @@ -40,7 +40,32 @@ The new `Allure.Net.Commons.AllureApi` facade class was designed specificially for test authors to enhance the Allure report. Prefer using functions in this class over the ones from `NUnit.Allure.Core.StepsHelper`. +### Namespace change + +Starting from 2.12.0, the namespace `NUnit.Allure` is deprecated. The API in +that namespace still works, but it will be removed in the future. Please, use +`Allure.NUnit` instead. + +> The `[NUnit.Allure.Core.AllureNUnit]` attribute should be replaced with +> `[Allure.NUnit.AllureNUnit]`: + +```c# +using Allure.NUnit; +using NUnit.Framework; + +[AllureNUnit] +class MyTests +{ + [Test] + public void TestMethod() + { + /* ... */ + } +} +``` + ### For users of Mac with Apple silicon + If you're developing on a Mac machine with Apple silicon, make sure you have Rosetta installed. Follow this article for the instructions: https://support.apple.com/en-us/HT211861 diff --git a/Allure.SpecFlow/README.md b/Allure.SpecFlow/README.md index 9624ec68..68cd60f8 100644 --- a/Allure.SpecFlow/README.md +++ b/Allure.SpecFlow/README.md @@ -18,7 +18,8 @@ --- -The plugin currently supports [SpecFlow](http://specflow.org/) v2.1 - 3.9.* +The adapter works with [SpecFlow](http://specflow.org/) version 3, starting from +3.9.8. ### Quick start @@ -54,7 +55,7 @@ Learn more from [the documentation for Allure SpecFlow](https://allurereport.org #### Selective run issues -Selective run might not work under rare circumstances. +Selective run (test plans) might not work under rare circumstances. Issue [#369] contains some additional details. If you are affected by this, you may try to switch to the `Debug` configuration as a workaround until we come up with a solution. diff --git a/Allure.Xunit/README.md b/Allure.Xunit/README.md index 54813d8e..b3bab23c 100644 --- a/Allure.Xunit/README.md +++ b/Allure.Xunit/README.md @@ -7,8 +7,21 @@ > An Allure adapter for [xUnit.net](https://xunit.net/). -Allure Xunit supports .NET Core 2.0 or later, or any .NET runtime that -implements .NET Standard 2.1. +[Allure Report logo](https://allurereport.org "Allure Report") + +- 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 + +--- + +Allure Xunit supports the following frameworks: + + - .NET Core 3.1, + - .NET 5.0 or greater. ## Quick start @@ -26,19 +39,22 @@ Some examples are available [here](https://github.com/allure-framework/allure-cs ## Notes ### Allure.Xunit.StepExtensions deprecation + There is no more need to use separate Allure.XUnit.StepExtensions package. You should uninstall it and use attributes from [Allure.Xunit.Attributes.Steps namespace](Attributes/Steps) directly. ### Namespace change + Previously, the package used a mix of `Allure.Xunit` and `Allure.XUnit` -namespaces. Starting from 2.12.0, you should only use `Allure.Xunit`. Some parts -of the public API are still accessible through the old namespace, but that -access is deprecated now and will be removed in the future. +namespaces. Starting from 2.12.0, you should only use `Allure.Xunit`. The API is +still accessible through the old namespace, but that access is deprecated now +and will be removed in the future. ## Known issues and limitations ### Rosetta is required for users on Mac with Apple silicon + If you're developing on a Mac machine with Apple silicon, make sure you have Rosetta installed. Follow this article for the instructions: https://support.apple.com/en-us/HT211861