docs: add migration notice for ASP.NET Core integration and move chan…

…gelog to GitHub releases.
skwasjer · Sep 2, 2023 · 3e3be5c · 3e3be5c
1 parent d2fd29a
commit 3e3be5c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 9 deletions.
diff --git a/Correlate.sln b/Correlate.sln
@@ -29,7 +29,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		.editorconfig = .editorconfig
 		.gitignore = .gitignore
 		appveyor.yml = appveyor.yml
-		CHANGELOG.md = CHANGELOG.md
 		Directory.Build.props = Directory.Build.props
 		README.md = README.md
 	EndProjectSection

diff --git a/CHANGELOG.md → OLD_CHANGELOG.md b/CHANGELOG.md → OLD_CHANGELOG.md
@@ -1,13 +1,8 @@
 # Changelog
 
-## Unreleased
-
-- Added .NET 7 target framework
-- Refactored ASP.NET Core integration to be based on `DiagnosticsListener`, by subscribing an observer and watch for HttpRequestIn (activity) events. This gives us the soonest opportunity to create the correlation context. Previously, `.UseCorrelate()` would register middleware. There were a few downsides with that approach, all having to do with _when_ the correlation context actually was being created:
-  - it was depending on the registration order when considering other middleware. F.ex. if `UseCorrelate()` was not called before any other middleware was registered, the correlation context was also not created as soon as possible.
-  - the ASP.NET Core its own built-in request-start and request-stop log messages did not have a Correlation ID property attached because the log scope created by Correlate is created after/disposed before these are emitted.
-  - for unhandled exceptions, the correlation context was already gone in the global exception handler because the request middleware pipeline completes before it gets there (unless you registered a custom one!). Again, this means those (default) log messages would not have a correlation ID property (see previous point).
-  - the middleware had a little too many allocations to my liking (considering that it runs in a fast-path).  
+## Future changelog moved to GitHub releases
+From v5.0.0 onwards, the changelog can be found at:
+https://github.com/skwasjer/Correlate/releases
 
 ## v4.0.0
 

diff --git a/src/Correlate.AspNetCore/README.md b/src/Correlate.AspNetCore/README.md
@@ -1,5 +1,9 @@
 Provides abstractions to correlate requests between microservices.
 
+### Migration from v4.x to 5.0.0
+
+- Replace `Correlate.AspNetCore.Middleware` namespace with `Correlate.AspNetCore`.
+
 ### Useful links
 
 - [GitHub / docs](https://github.com/skwasjer/Correlate)