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.

Sign up for GitHub

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

Add migration guide #805

Merged
merged 3 commits into from
Dec 20, 2024
Merged

Add migration guide #805

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ce3b7a
Add migration guide
martincostello Dec 20, 2024
fe5bd7f
Fix typo
martincostello Dec 20, 2024
bdc9165
Fix typo
martincostello Dec 20, 2024
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,23 @@ See below for links to more examples:
- [Unit tests][example-unit-tests]
- [Integration tests for an ASP.NET Core HTTP application][example-integration-tests]

## Migrating to xunit v3

[Xunit v3][xunit-v3-whats-new] contains many major architectural changes which means the same package
that supports logging for xunit v2 cannot be used with xunit v3. The equivalent NuGet package to support
logging for xunit v3 is the new [MartinCostello.Logging.XUnit.v3][package-download-v3] package.

To migrate usage of `MartinCostello.Logging.XUnit` to `MartinCostello.Logging.XUnit.v3` for xunit v3:

1. Follow the relevant steps to migrate any test projects from [xunit v2 to v3][xunit-v3-migration].
- The most relevant change in xunit v3 is that the `ITestOutputHelper` type has moved from the `Xunit.Abstractions` namespace to `Xunit`.
1. Change any package references from `MartinCostello.Logging.XUnit` to `MartinCostello.Logging.XUnit.v3`.

```diff
- <PackageReference Include="MartinCostello.Logging.XUnit" Version="0.5.0" />
+ <PackageReference Include="MartinCostello.Logging.XUnit.v3" Version="0.5.0" />
```

## Feedback

Any feedback or issues can be added to the issues for this project in [GitHub][issues].
Expand Down Expand Up @@ -130,3 +147,5 @@ cd xunit-logging
[repo]: https://github.com/martincostello/xunit-loggingE "This project on GitHub.com"
[serilog]: https://serilog.net/ "Serilog website"
[serilog-sinks-xunit]: https://github.com/trbenning/serilog-sinks-xunit "Serilog.Sinks.XUnit on GitHub"
[xunit-v3-migration]: https://xunit.net/docs/getting-started/v3/migration "Migrating from xunit v2 to v3"
[xunit-v3-whats-new]: https://xunit.net/docs/getting-started/v3/whats-new "What's New in v3"
Loading