Skip to content

Commit 4a5b9ad

Browse files
Add migration guide (#805)
Add a migration guide for moving from xunit v2 to v3.
1 parent e39e9bf commit 4a5b9ad

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,23 @@ See below for links to more examples:
8686
- [Unit tests][example-unit-tests]
8787
- [Integration tests for an ASP.NET Core HTTP application][example-integration-tests]
8888

89+
## Migrating to xunit v3
90+
91+
[Xunit v3][xunit-v3-whats-new] contains many major architectural changes which means the same package
92+
that supports logging for xunit v2 cannot be used with xunit v3. The equivalent NuGet package to support
93+
logging for xunit v3 is the new [MartinCostello.Logging.XUnit.v3][package-download-v3] package.
94+
95+
To migrate usage of `MartinCostello.Logging.XUnit` to `MartinCostello.Logging.XUnit.v3` for xunit v3:
96+
97+
1. Follow the relevant steps to migrate any test projects from [xunit v2 to v3][xunit-v3-migration].
98+
- The most relevant change in xunit v3 is that the `ITestOutputHelper` type has moved from the `Xunit.Abstractions` namespace to `Xunit`.
99+
1. Change any package references from `MartinCostello.Logging.XUnit` to `MartinCostello.Logging.XUnit.v3`.
100+
101+
```diff
102+
- <PackageReference Include="MartinCostello.Logging.XUnit" Version="0.5.0" />
103+
+ <PackageReference Include="MartinCostello.Logging.XUnit.v3" Version="0.5.0" />
104+
```
105+
89106
## Feedback
90107

91108
Any feedback or issues can be added to the issues for this project in [GitHub][issues].
@@ -127,6 +144,8 @@ cd xunit-logging
127144
[package-badge-version-v3]: https://img.shields.io/nuget/v/MartinCostello.Logging.XUnit.v3?logo=nuget&label=Latest&color=blue
128145
[package-download-v2]: https://www.nuget.org/packages/MartinCostello.Logging.XUnit "Download MartinCostello.Logging.XUnit from NuGet"
129146
[package-download-v3]: https://www.nuget.org/packages/MartinCostello.Logging.XUnit.v3 "Download MartinCostello.Logging.XUnit.v3 from NuGet"
130-
[repo]: https://github.com/martincostello/xunit-loggingE "This project on GitHub.com"
147+
[repo]: https://github.com/martincostello/xunit-logging "This project on GitHub.com"
131148
[serilog]: https://serilog.net/ "Serilog website"
132149
[serilog-sinks-xunit]: https://github.com/trbenning/serilog-sinks-xunit "Serilog.Sinks.XUnit on GitHub"
150+
[xunit-v3-migration]: https://xunit.net/docs/getting-started/v3/migration "Migrating from xunit v2 to v3"
151+
[xunit-v3-whats-new]: https://xunit.net/docs/getting-started/v3/whats-new "What's New in v3"

0 commit comments

Comments
 (0)