Skip to content

Upgrading YamlDotNet 5 to 6

Breaking5.4.0 → 6.1.2Breaking3New2Changed2Fixed11Other2

Full comparisonBack to YamlDotNet
BreakingUpgrade verdict

3 breaking changes.

In plain terms
  • The separate signed package is discontinued. Use the regular YamlDotNet package, which is now strong-named.
  • The two versions of the library, one with strong names and one without, are now a single package. The remaining package always uses strong names.
  • The library's internal assembly identity changed. If another library you use was built against an older YamlDotNet, it will not load until that library is updated.
Must act 3 items need code or config changes

What you must change

Breaking3
The YamlDotNet.Signed package is no longer published; code should depend on YamlDotNet instead.
6.0.0GitHub ReleaseSummarizedView source
Merges the YamlDotNet.Signed and YamlDotNet packages, so assemblies in the YamlDotNet package now have strong names.
6.0.0GitHub ReleaseSummarizedView source
Assemblies in the YamlDotNet package now have strong names, which is a breaking change for libraries depending on previous versions.
6.0.0GitHub ReleaseSummarizedView source

API changes

Generated by DepDelta from published .NET assemblies. Not mixed with prose notes.

  • added: ctor Emitter(TextWriter output, EmitterSettings settings)
  • added: ctor EmitterSettings()
  • added: ctor EmitterSettings(int bestIndent, int bestWidth, bool isCanonical, int maxSimpleKeyLength)
  • added: method EmitterSettings.Canonical(): EmitterSettings
  • added: method EmitterSettings.WithBestIndent(int bestIndent): EmitterSettings
  • added: method EmitterSettings.WithBestWidth(int bestWidth): EmitterSettings
  • added: method EmitterSettings.WithMaxSimpleKeyLength(int maxSimpleKeyLength): EmitterSettings
  • added: property EmitterSettings.BestIndent: int { get; }
  • added: property EmitterSettings.BestWidth: int { get; }
  • added: property EmitterSettings.IsCanonical: bool { get; }
  • added: property EmitterSettings.MaxSimpleKeyLength: int { get; }
  • added: sealed class EmitterSettings
  • added: static readonly field EmitterSettings.Default: EmitterSettings
  • added: method YamlStream.Save(IEmitter emitter, bool assignAnchors): void
  • changed: static method Serializer.FromValueSerializer(IValueSerializer valueSerializer): Serializer → static method Serializer.FromValueSerializer(IValueSerializer valueSerializer, EmitterSettings emitterSettings): Serializer