Skip to content

Commit

Permalink
Set the version to 2.0.0 for release.
Browse files Browse the repository at this point in the history
Updated the release notes with the changes in this release.
  • Loading branch information
Zastai committed Apr 24, 2020
1 parent 53fa7c2 commit 8715ff5
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 5 deletions.
2 changes: 1 addition & 1 deletion MetaBrainz.Common.Json/MetaBrainz.Common.Json.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<Title>Common JSON Utilities</Title>
<Description>This package provides JSON-related utility classes used by other MetaBrainz packages.</Description>
<PackageTags>MetaBrainz JSON</PackageTags>
<Version>2.0.0-pre</Version>
<Version>2.0.0</Version>
</PropertyGroup>

<PropertyGroup>
Expand Down
47 changes: 44 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,56 @@ JSON-related helper classes, for use by the other `MetaBrainz.*` packages.

## Release Notes

### v1.2.0 (_work in progress_)

#### API Changes
### v2.0.0 (2020-04-24)

#### API Additions

- New Method: `JsonUtils.CreateReaderOptions()`, optionally specifying a set of converters to register
- New Method: `JsonUtils.CreateWriterOptions()`, optionally specifying a set of converters to register
- New Method: `JsonUtils.DeserializeAsync()`
- New Extension Method: `JsonUtils.GetObject()`
- New Extension Method: `JsonUtils.GetOptionalBoolean()`
- New Extension Method: `JsonUtils.GetOptionalByte()`
- New Extension Method: `JsonUtils.GetOptionalDateTimeOffset()`
- New Extension Method: `JsonUtils.GetOptionalDecimal()`
- New Extension Method: `JsonUtils.GetOptionalDouble()`
- New Extension Method: `JsonUtils.GetOptionalGuid()`
- New Extension Method: `JsonUtils.GetOptionalInt16()`
- New Extension Method: `JsonUtils.GetOptionalInt32()`
- New Extension Method: `JsonUtils.GetOptionalInt64()`
- New Extension Method: `JsonUtils.GetOptionalObject()`
- New Extension Method: `JsonUtils.GetOptionalSbyte()`
- New Extension Method: `JsonUtils.GetOptionalSingle()`
- New Extension Method: `JsonUtils.GetOptionalUInt16()`
- New Extension Method: `JsonUtils.GetOptionalUInt32()`
- New Extension Method: `JsonUtils.GetOptionalUInt64()`
- New Extension Method: `JsonUtils.GetOptionalUri()`
- New Extension Method: `JsonUtils.GetOptionalValue()`
- New Extension Method: `JsonUtils.GetUri()`
- New Extension Method: `JsonUtils.GetValue()`
- New Extension Method: `JsonUtils.ReadDictionary()`
- New Extension Method: `JsonUtils.TryGetUri()`

#### API Changes

- `AnyObjectReader` is now a `JsonReader<object>` instead of `JsonReader<object?>` and will no longer deserialize a JSON `null`
- *this is a breaking change*
- note: it will still handle `null`s inside arrays or objects it deserializes
- `JsonBasedObject.UnhandledProperties` is now an `IReadOnlyDictionary<string, object?>?` instead of `Dictionary<string, object?>?`
and is no longer marked `[JsonExtensionData]`
- *this is a breaking change*
- `JsonUtils.ReadList()` is now an extension method
- `JsonUtils.WriteList()` is now an extension method
- `JsonUtils.ReadList()` now takes the serializer options as the last argument
- *this is a breaking change*

#### API Removals

- `AnyObjectConverter` has been removed
- it has been superseded by `AnyObjectReader`
- `InterfaceConverter` and `ReadOnlyListOfInterfaceConverter` have been removed
- the MetaBrainz libraries are switching to custom converters for everything, removing the need for these

#### Other Changes

#### Dependency Updates
Expand Down
2 changes: 1 addition & 1 deletion appveyor.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 2.0.0-appveyor.{build}
version: 2.0.0
image: Visual Studio 2019
configuration: Debug
install:
Expand Down

0 comments on commit 8715ff5

Please sign in to comment.