Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README files for allure-xunit and allure-specflow are updated to reflect recent changes #397

Merged
merged 1 commit into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Allure.SpecFlowPlugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,3 +241,13 @@ AllureLifecycle.Instance.AddAttachment(path, "Attachment Title");
AllureLifecycle.Instance.AddAttachment("Attachment Title", "application/txt", "path");
// where "application/txt" - type of your attachment
```

### Known issues

#### Selective run might not work

Under rare circumstances selective run feature might not work.
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.
46 changes: 27 additions & 19 deletions Allure.XUnit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@ with .NET Standard 2.1.

## How to run

Install the Allure.XUnit package and create `allureConfig.json`. Here is the
basic content of the config:
Install the Allure.XUnit package and run the tests normally. In many cases
allure should start automatically. The result files are created in the
`allure-results` directory in the target directory.
If that didn't happen, check out the `Running tests in a CI pipeline` section.

```json
{
"allure": {}
}
```
### Configuration

Make sure the config is copied to the output directory:
If you need to configure allure-xunit, create `allureConfig.json` and make sure
it is copied to the output directory:

- In Visual Studio select the file and set the following properties:
- Build Action: Content
Expand All @@ -33,10 +32,18 @@ Make sure the config is copied to the output directory:
</ItemGroup>
```

Then, run the tests as usual. In many cases allure should start automatically.
The result files are created in the `allure-results` directory in the
target directory.
If that didn't happen, check out the `Running tests in a CI pipeline` section.
An example of the config:

```json
{
"allure": {
"allure-directory": "allure-results",
"links": [
"https://github.com/allure-framework/allure-csharp/issues/{issue}"
]
}
}
```

### Running tests in a CI pipeline

Expand Down Expand Up @@ -204,13 +211,6 @@ You may also install Rosetta via the CLI:
/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
throws otherwise. This requirement will be lifted in the near future.

Here is the issue to track the progress: [#381].

### Arguments of some theories might be unreported

Under rare circumstances arguments of some theories might be missing in the
Expand All @@ -219,6 +219,14 @@ report produced by allure-xunit. Issue [#369] contains some additional details.
If you are affected by this, you may switch to the `Debug` configuration as a
workaround until we come up with a solution.

### Selective run might not work

Under rare circumstances selective run feature might not work.
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.

## Examples

See [Examples](../Allure.XUnit.Examples).
Expand Down
Loading