Skip to content

Commit

Permalink
Update Xunit and NUnit readmes
Browse files Browse the repository at this point in the history
  - Add namespace change note to Allure.NUnit
  - Fix [AllureNUnit]'s namespace
  - Add header and supported TFMs to Allure.Xunit
  - Fix supported SpecFlow versions
  • Loading branch information
delatrie committed Mar 28, 2024
1 parent dbc9b9c commit eb26699
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 10 deletions.
31 changes: 28 additions & 3 deletions Allure.NUnit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
5 changes: 3 additions & 2 deletions Allure.SpecFlow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down
26 changes: 21 additions & 5 deletions Allure.Xunit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](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

Expand All @@ -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
Expand Down

0 comments on commit eb26699

Please sign in to comment.