search

serilog / serilog-sinks-console

Write log events to System.Console as text or JSON, with ANSI theme support
Apache License 2.0
248 stars 72 forks source link

Changelog does not mention what the breaking change is #113

Closed joukevandermaas closed 3 years ago

joukevandermaas commented 3 years ago

A few questions before you begin:

Is this an issue related to the Serilog core project or one of the sinks or community projects. This issue list is intended for Serilog core issues. If this issue relates to a sink or related project, please log on the related repository. Please use Gitter chat and Stack Overflow for discussions and questons.

This is about serilog-sinks-console (this repo).

Does this issue relate to a new feature or an existing bug?

What version of Serilog Console Sink is affected by this issue? Please list the related NuGet package.

4.0.0: https://github.com/serilog/serilog-sinks-console/releases/tag/v4.0.0

What is the target framework and operating system affected by this issue? Please see target frameworks & net standard matrix.

Please describe the current behaviour you are experiencing?

When upgrading a package, especially when there is a major version bump, I look at the changelog to see what the breaking change was so I can know what I need to do to upgrade. The changelog for 4.0.0 is just a bunch of PR references. I've looked through them but I can't really see what would break just from that, especially since they're just links with no additional text.

Please describe the expected behaviour if the ?

A small line describing the breaking change would be much appreciated. I understand time is short so it doesn't have to be a lot, just enough to indicate what I should look out for when upgrading.

nblumhardt commented 3 years ago

Fixed -

Thanks! :+1:

nblumhardt commented 3 years ago

(In https://github.com/serilog/serilog-sinks-console/releases/tag/v4.0.0 ... unfortunately, GitHub doesn't expand issue/PR references to their full titles in release descriptions, so still some work to do rewriting the release notes there, too :-/ )

joukevandermaas commented 3 years ago

Thank you very much! I appreciate the quick response.

erichiller commented 3 years ago

About the syncRoot addition... Is there a way to configure this using ConfigurationBuilder and .ReadFrom.Configuration( ) on LoggerConfiguration ?