Merge pull request #738 from polyadic/release-3.3.0

polyadic · Jul 14, 2023 · bf99212 · bf99212
2 parents 5af7e74 + 4257445
commit bf99212
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 3 deletions.
diff --git a/Funcky.Analyzers/Funcky.Analyzers.Package/Funcky.Analyzers.Package.csproj b/Funcky.Analyzers/Funcky.Analyzers.Package/Funcky.Analyzers.Package.csproj
@@ -12,7 +12,7 @@
     </PropertyGroup>
     <PropertyGroup Label="NuGet Metadata">
         <PackageId>Funcky.Analyzers</PackageId>
-        <PackageVersion>1.2.0</PackageVersion>
+        <PackageVersion>1.3.0</PackageVersion>
         <Description>Analyzers to guide to the correct usage of Funcky.</Description>
         <PackageTags>funcky, analyzers, roslyn</PackageTags>
         <DevelopmentDependency>true</DevelopmentDependency>

diff --git a/Funcky.Analyzers/Funcky.Analyzers/AnalyzerReleases.Shipped.md b/Funcky.Analyzers/Funcky.Analyzers/AnalyzerReleases.Shipped.md
@@ -24,3 +24,4 @@ Rule ID | Category | Severity | Notes
 λ1007 | Funcky | Warning | OptionMatchAnalyzer
 λ1008 | Funcky | Warning | OptionMatchAnalyzer
 
+## Release 1.3
diff --git a/Funcky.Xunit/Funcky.Xunit.csproj b/Funcky.Xunit/Funcky.Xunit.csproj
@@ -5,7 +5,7 @@
         <Nullable>enable</Nullable>
         <Description>Package to use Funcky with xUnit</Description>
         <PackageTags>Functional Monad xUnit</PackageTags>
-        <Version>2.0.0</Version>
+        <Version>2.0.1</Version>
         <IncludeSymbols>true</IncludeSymbols>
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
         <RootNamespace>Funcky</RootNamespace>

diff --git a/Funcky/Funcky.csproj b/Funcky/Funcky.csproj
@@ -7,7 +7,7 @@
         <Product>Funcky</Product>
         <Description>Funcky is a functional C# library</Description>
         <PackageTags>Functional Monad Linq</PackageTags>
-        <VersionPrefix>3.2.0</VersionPrefix>
+        <VersionPrefix>3.3.0</VersionPrefix>
         <IncludeSymbols>true</IncludeSymbols>
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
         <PackageReadmeFile>README.md</PackageReadmeFile>

diff --git a/changelog.md b/changelog.md
@@ -2,6 +2,21 @@
 All notable changes to this project will be documented in this file.
 Funcky adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Funcky 3.3.0 | Funcky.Analyzers 1.3.0 | Funcky.Xunit 2.0.1
+This is a relatively minor release focuses on convenience for our monads `Option`, `Either` and `Result`.
+
+### `GetOrElse` and `OrElse` for all
+We've added `GetOrElse` and `OrElse` to `Either` and `Result` bringing them on par with `Option`. \
+The corresponding analyzer now also correctly suggests using these methods instead of `Match` for `Result` and `Either`.
+
+### `Inspect` for the error case
+All three alternative monads `Option`, `Either` and `Result` now support inspecting the «error» case:
+* `Option.InspectNone` - executes a side effect only when the option is `None`.
+* `Either.InspectLeft` - executes a side effect only when the either is on the `Left` side.
+* `Result.InspectError` - executes a side effect only when the result is an `Error`.
+
+These methods are particularly useful for logging warnings/errors.
+
 ## Funcky 3.2.0 | Funcky.Async 1.2.0
 ### List Pattern for Option
 We've added support for C# 11's List Patterns to `Option<T>`.