Skip to content

Commit

Permalink
Add Rosetta warning in package READMEs. Fix allure-nunit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
delatrie committed Oct 13, 2023
1 parent 55be531 commit 42a07e1
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 7 deletions.
24 changes: 17 additions & 7 deletions Allure.NUnit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ NUnit adapter for Allure Framework
[![Nuget](https://img.shields.io/nuget/v/Allure.NUnit?style=flat)](https://www.nuget.org/packages/Allure.NUnit)
[![Nuget pre](https://img.shields.io/nuget/vpre/Allure.Nunit?style=flat)](https://www.nuget.org/packages/Allure.NUnit)

![Nuget downloads](https://img.shields.io/nuget/dt/nunit.allure?label=downloads&style=flat)
![Nuget downloads](https://img.shields.io/nuget/dt/allure.nunit?label=downloads&style=flat)



![Allure report](https://raw.githubusercontent.com/unickq/allure-nunit/master/AllureScreen.png)


### [Code examples](https://github.com/unickq/allure-nunit/tree/master/src/allure-nunit-tests):
### [Code examples](https://github.com/allure-framework/allure-csharp/tree/main/Allure.NUnit.Examples):

```cs
[TestFixture(Author = "unickq", Description = "Examples")]
[AllureNUnit]
[AllureLink("https://github.com/unickq/allure-nunit")]
[AllureLink("https://github.com/allure-framework/allure-csharp")]
public class Tests
{
[OneTimeSetUp]
Expand All @@ -25,7 +25,6 @@ public class Tests
AllureLifecycle.Instance.CleanupResultDirectory();
}

//Allure.Steps required
[AllureStep("This method is just saying hello")]
private void SayHello()
{
Expand All @@ -34,7 +33,7 @@ public class Tests

[Test]
[AllureTag("NUnit", "Debug")]
[AllureIssue("GitHub#1", "https://github.com/unickq/allure-nunit")]
[AllureIssue("GitHub#1", "https://github.com/allure-framework/allure-csharp")]
[AllureSeverity(SeverityLevel.critical)]
[AllureFeature("Core")]
[AllureId(123)]
Expand All @@ -53,5 +52,16 @@ public class Tests
### Installation and Usage
- Download from Nuget with all dependencies
- Configure allureConfig.json
- Set `[AllureNUnit]` attribute under test fixture
- Use other [attributes](https://github.com/unickq/allure-nunit/wiki/Attributes) if needed
- Apply the `[AllureNUnit]` attribute to test fixtures
- Use other attributes in `NUnit.Allure.Attributes` if needed

#### 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

You may also install Rosetta via the CLI:

```shell
/usr/sbin/softwareupdate --install-rosetta --agree-to-license
```
12 changes: 12 additions & 0 deletions Allure.Net.Commons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ Can be targeted either by legacy .net 4.5+ or .net standard 2.* projects.

Use this library to create custom Allure adapters for .Net test frameworks.

### Note 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

You may also install Rosetta via the CLI:

```shell
/usr/sbin/softwareupdate --install-rosetta --agree-to-license
```

### Configuration
Allure lifecycle is configured via json file with default name `allureConfig.json`. NuGet package installs `allureConfig.Template.json` which you can use as an example. There are 2 ways to specify config file location:
- set ALLURE_CONFIG environment variable to the full path of json config file. This option is preferable for .net core projects which utilize nuget libraries directly from nuget packages folder. See this example of setting it via code: https://github.com/allure-framework/allure-csharp/blob/bdf11bd3e1f41fd1e4a8fd22fa465b90b68e9d3f/Allure.Commons.NetCore.Tests/AllureConfigTests.cs#L13-L15
Expand Down
12 changes: 12 additions & 0 deletions Allure.SpecFlowPlugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ Please use corresponding NuGet package version.
Install [Allure.SpecFlow](https://www.nuget.org/packages/Allure.SpecFlow)
nuget package according to your Specflow version.

#### 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

You may also install Rosetta via the CLI:

```shell
/usr/sbin/softwareupdate --install-rosetta --agree-to-license
```

### Configuration

For Specflow 3 please add or update the following section in your specflow.json:
Expand Down
11 changes: 11 additions & 0 deletions Allure.XUnit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,17 @@ Use [`AllureAttachments`](AllureAttachments.cs) class with its methods. (Attachm

## 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

You may also install Rosetta via the CLI:

```shell
/usr/sbin/softwareupdate --install-rosetta --agree-to-license
```

### allureConfig.json is required even if no config properties are present

The configuration file must be present in the output directory. Allure.XUnit
Expand Down

0 comments on commit 42a07e1

Please sign in to comment.