](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
+
+---
+
+The library can be used by any project targeting a netstandard2.0 compatible
+framework including .NET Framework 4.6.1+, .NET Core 2.0+, .NET 5.0+ and more.
+See the full list [here](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0#select-net-standard-version).
## Note for users of Mac with Apple silicon
@@ -20,10 +32,10 @@ You may also install Rosetta via the CLI:
```
## 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
+Allure lifecycle is configured via a json file with the 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 in the code: https://github.com/allure-framework/allure-csharp/blob/bdf11bd3e1f41fd1e4a8fd22fa465b90b68e9d3f/Allure.Commons.NetCore.Tests/AllureConfigTests.cs#L13-L15
-- place `allureConfig.json` to the location of `Allure.Commons.dll`. This option can be used with .net classic projects which copy all referenced package libraries into binary folder. Do not forget to set 'Copy to Output Directory' property to 'Copy always' or 'Copy if newer' in your test project or set it in .csproj:
+- place `allureConfig.json` to the location of `Allure.Net.Commons.dll`. This option can be used with .net classic projects which copy all referenced package libraries into binary folder. Do not forget to set 'Copy to Output Directory' property to 'Copy always' or 'Copy if newer' in your test project or set it in .csproj:
```xml
](https://allurereport.org "Allure Report")
-Install [Allure.SpecFlow](https://www.nuget.org/packages/Allure.SpecFlow)
+- 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
+
+---
+
+The plugin currently supports [SpecFlow](http://specflow.org/) v2.1 - 3.9.*
+
+### Quick start
+
+1. Install the [Allure.SpecFlow](https://www.nuget.org/packages/Allure.SpecFlow)
nuget package according to your Specflow version.
+2. Add the following entry to your `specflow.json`:
+ ```json
+ {
+ "stepAssemblies": [
+ {"assembly": "Allure.SpecFlowPlugin"}
+ ]
+ }
+ ```
+3. Run the tests.
#### For users of Mac with Apple silicon
@@ -24,230 +46,20 @@ You may also install Rosetta via the CLI:
/usr/sbin/softwareupdate --install-rosetta --agree-to-license
```
-### Configuration
-
-For Specflow 3 please add or update the following section in your specflow.json:
-
-```json
-{
- "stepAssemblies": [
- { "assembly": "Allure.SpecFlowPlugin" }
- ]
-}
-```
-
-The plugin uses allureConfig.json extended with custom sections that are
-described below.
-
-#### Custom host name
-
-In case if you want to customize host name which is displayed in Allure Timeline
-section, please configure `allure.title` property in json configuraion file.
-
-```json
-{
- "allure": {
- "title": "My title"
- }
-}
-```
-
-#### If you use NUnit
-
-The default value for allure.directory in allureConfig.json is "allure-results".
-The default working directory in NUnit 3.* depends on what runner you use.
-
-If you don't want to place allure results into NUnit default working folder
-please either set absolute path in allure.config or set working directory for
-NUnit in your test setup, e.g.:
-
-``` csharp
-[OneTimeSetUp]
-public void Init()
-{
- Environment.CurrentDirectory = Path.GetDirectoryName(GetType().Assembly.Location);
-}
-```
-
-### Usage
-
-Just run your SpecFlow scenarios and find the `allure-results` folder ready to
-generate Allure report.
-
-### Features
-
-#### Grouping
-
-You can structure your scenarios in 3 Allure hierarchies using feature and
-scenario tags.
-Please read [report structure](https://docs.qameta.io/allure/latest/#_report_structure)
-Allure documentation section for additional details. Hierarchies consist of
-the following levels:
-
-**Suites**
-* Parent Suite
-* * Suite
-* * * Sub Suite
-
-**Behaviors**
-* Epic
-* * Feature
-* * * Story
-
-**Packages**
-* Package
-* * Class
-* * * Method
-
-The plugin uses `allure:grouping` configuration section to parse tags with the
-regular expression. If the expression contains the group, it will be used as
-hierarchy level name otherwise entire match will be used. E.g:
-
-`^mytag.*` : any tags starting with `@mytag` will be used for grouping.
-
-`^type:(ui|api)` : `@ui` or `@api` tags from regex pattern will be used for
-grouping.
-
-Check this [config example](https://github.com/allure-framework/allure-csharp/blob/main/Tests.SpecRun/allureConfig.json)
-as a starting point.
-
-#### Links
-You can add links to your scenarios using tags. Tag and link patterns can be
-configured in `allureConfig.json`
-
-``` json
-{
- "allure": {
- "links": [
- "https://myissuetracker.org/{issue}",
- "https://mytestmanagementsystem.org?test={tms}"
- ]
- },
- "specflow": {
- "links": {
- "link": "^link:(.+)",
- "issue": "^\\d+",
- "tms": "^tms:(\\d+)"
- }
- }
-}
-```
+### Further readings
-The following scenario
-
-``` cucumber
-@123456 @tms:42 @link:http://example.org
-Scenario: I do like click on links in Allure report
-```
-
-will have three links in Allure report:
-[123456](https://myissuetracker.org/123456),
-[42](https://mytestmanagementsystem.org?test=tms-42) and http://example.org.
-
-Links generated dynamically during the tests can be added in code via
-AllureLifecycle. The next example adds the [Example link](http://example.com)
-link at runtime:
-
-``` c#
-AllureLifecycle.Instance.UpdateTestCase(tc =>
-{
- tc.links.Add(new Link()
- {
- name = "Example link",
- url = "http://example.com"
- });
-});
-```
-
-#### Severity
-You can add Severity for your scenarios using tags. It can be configured in
-`allureConfig.json`:
-
-``` json
- "labels": {
- "severity": "^(normal|blocker|critical|minor|trivial)"
- },
-```
-
-The following scenario
-
-``` cucumber
-@critical
-Scenario: ....
-```
-
-sets the current scenario's severity in Allure report as Blocker.
-
-#### Label
-
-You can add allure labels for your scenarios using tags. It can be configured
-in `allureConfig.json`:
-
-``` json
- "labels": {
- "label": "^label:([\\w]+):(.+)"
- },
-```
-
-The following scenario
-
-``` cucumber
-@label:layer:e2e: @label:allure_id:123
-Scenario: ....
-```
-
-sets the current scenario's layer as e2e and Id as 123 in Allure report
-
-#### Tables conversion
-
-Table arguments in SpecFlow steps can be converted either to step
-csv-attacments or step parameters in the Allure report. The conversion is
-configurable in `specflow:stepArguments` config section.
-
-With `specflow:stepArguments:convertToParameters` set to `true` the following
-table arguments will be represented as parameters:
-
-* one row tables
-* two column tables with the headers matching both
- `specflow:stepArguments:paramNameRegex` and
- `specflow:stepArguments:paramValueRegex` regular expressions.
-
-| SpecFlow | -Allure | -
|---|---|
| - - - - | -- - - - | -