Merge pull request #80 from shinji-san/release-v0.8.0

Release v0.8.0

Added
- Added more examples in the section Usage of the README.md file to explain the use of shares and the use of the new type casting from byte array to secret and vice versa.
- Added method MakeShares(TNumber numberOfMinimumShares, TNumber numberOfShares, int securityLevel)
- Added method MakeShares(TNumber numberOfMinimumShares, TNumber numberOfShares, Secret<TNumber> secret, int securityLevel)
- Added localization for exception messages in English and German languages

Changed
- Changed existing examples in the section Usage of the README.md file to explain the use and the type casting of recovered secrets.
- Minify NuGet package README.md
- Changed ctor ShamirsSecretSharing(IExtendedGcdAlgorithm<TNumber> extendedGcd). This ctor sets the SecurityLevel to 13.

Deprecated
- Ctor ShamirsSecretSharing(IExtendedGcdAlgorithm<TNumber> extendedGcd, int securityLevel) is deprecated.
- Method MakeShares(TNumber numberOfMinimumShares, TNumber numberOfShares) is deprecated.
- Shares to tuple type casting is obsolete and will be remove in the next release.
- Shares.Item1 property is obsolete and will be remove in the next release.
- Shares.Item2 property is obsolete and will be remove in the next release.

Removed
- Removed .NET 5 support, because it retires on May 10, 2022. See Microsoft .NET and .NET Core - Support Dates.

Resolves: No entry

Author: shinji-san

.github/workflows/codeql-analysis.yml

@@ -46,19 +46,14 @@ jobs:
       with:
         dotnet-version: 3.1.415
 
-    - name: Setup .NET 5
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: 5.0.403
-
     - name: Setup .NET 6
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: 6.0.100
 
     - name: .NET Core SxS
       run: |
-        rsync -a ${DOTNET_ROOT/6.0.100/5.0.403/3.1.415}/* $DOTNET_ROOT/
+        rsync -a ${DOTNET_ROOT/6.0.100/3.1.415}/* $DOTNET_ROOT/
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/dotnetall.yml

@@ -23,19 +23,14 @@ jobs:
       with:
         dotnet-version: 3.1.415
 
-    - name: Setup .NET 5
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: 5.0.403
-
     - name: Setup .NET 6
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: 6.0.100
 
     - name: .NET Core SxS
       run: |
-        rsync -a ${DOTNET_ROOT/6.0.100/5.0.403/3.1.415}/* $DOTNET_ROOT/
+        rsync -a ${DOTNET_ROOT/6.0.100/3.1.415}/* $DOTNET_ROOT/
 
     - name: Restore
       run: dotnet restore SecretSharingDotNet.sln
@@ -46,5 +41,10 @@ jobs:
     - name: Test
       run: dotnet test --configuration Release SecretSharingDotNet.sln
 
+    - name: Prepare README.md for NuGet package
+      run: |
+           grep -n "## Install SecretSharingDotNet package" README.md | cut -d: -f 1| xargs -i tail -n +{} README.md > TMP.md && sed -i '1s/^/# Setup\r\n/' TMP.md && mv -f TMP.md README.md
+           grep -n "# CLI building instructions" README.md | cut -d: -f 1| xargs -i head -n {} README.md | head -n -1 > TMP.md && mv -f TMP.md README.md
+
     - name: Create Package
       run: dotnet pack --configuration Release SecretSharingDotNet.sln

.github/workflows/dotnetcore.yml

@@ -17,7 +17,7 @@ jobs:
       DOTNET_CLI_TELEMETRY_OPTOUT: true
     strategy:
       matrix:
-        dotnet: [ '3.1.415', '5.0.403', '6.0.100']
+        dotnet: [ '3.1.415', '6.0.100']
     name: Dotnet ${{ matrix.dotnet }}
 
     steps:
@@ -32,12 +32,6 @@ jobs:
     - name: Test with donet SDK v3.1
       if: matrix.dotnet == '3.1.415'
       run: dotnet test -v d --configuration Release SecretSharingDotNetCore3.1.sln
-    - name: Build with dotnet SDK v5.0
-      if: matrix.dotnet == '5.0.403'
-      run: dotnet build --configuration Release SecretSharingDotNet5.sln
-    - name: Test with dotnet SDK v5.0
-      if: matrix.dotnet == '5.0.403'
-      run: dotnet test --configuration Release SecretSharingDotNet5.sln
     - name: Build with dotnet SDK v6.0
       if: matrix.dotnet == '6.0.100'
       run: dotnet build --configuration Release SecretSharingDotNet6.sln

.github/workflows/dotnetfx.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   build:
 
-    runs-on: windows-latest
+    runs-on: windows-2019
 
     steps:
       - name: checkout

.github/workflows/publishing.yml

@@ -21,19 +21,14 @@ jobs:
       with:
         dotnet-version: 3.1.415
 
-    - name: Setup .NET 5
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: 5.0.403
-
     - name: Setup .NET 6
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: 6.0.100
 
     - name: .NET Core SxS
       run: |
-        rsync -a ${DOTNET_ROOT/6.0.100/5.0.403/3.1.415}/* $DOTNET_ROOT/
+        rsync -a ${DOTNET_ROOT/6.0.100/3.1.415}/* $DOTNET_ROOT/
 
     - name: Decrypt large secret
       run: ./.github/secrets/decrypt_publisher_snk.sh
@@ -53,6 +48,11 @@ jobs:
     - name: Remove obsolete NuGet packages
       run: rm -f src/bin/Release/SecretSharingDotNet*.nupk
 
+    - name: Prepare README.md for NuGet package
+      run: |
+           grep -n "## Install SecretSharingDotNet package" README.md | cut -d: -f 1| xargs -i tail -n +{} README.md > TMP.md && sed -i '1s/^/# Setup\r\n/' TMP.md && mv -f TMP.md README.md
+           grep -n "# CLI building instructions" README.md | cut -d: -f 1| xargs -i head -n {} README.md | head -n -1 > TMP.md && mv -f TMP.md README.md
+
     - name: Create package
       run: dotnet pack --configuration Release SecretSharingDotNet.sln
 

CHANGELOG.md

@@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.0] - 2022-07-05
+### Added
+- Added more examples in the section *Usage* of the `README.md` file to explain the use of shares and the use of the new type casting from byte array to secret and vice versa.
+- Added method `MakeShares(TNumber numberOfMinimumShares, TNumber numberOfShares, int securityLevel)`
+- Added method `MakeShares(TNumber numberOfMinimumShares, TNumber numberOfShares, Secret<TNumber> secret, int securityLevel)`
+- Added localization for exception messages in English and German languages
+
+### Changed
+- Changed existing examples in the section *Usage* of the `README.md` file to explain the use and the type casting of recovered secrets.
+- Minify NuGet package README.md
+- Changed ctor `ShamirsSecretSharing(IExtendedGcdAlgorithm<TNumber> extendedGcd)`. This ctor sets the SecurityLevel to 13.
+
+### Deprecated
+- Ctor `ShamirsSecretSharing(IExtendedGcdAlgorithm<TNumber> extendedGcd, int securityLevel)` is deprecated.
+- Method `MakeShares(TNumber numberOfMinimumShares, TNumber numberOfShares)` is deprecated.
+- Shares to tuple type casting is obsolete and will be remove in the next release.
+- Shares.Item1 property is obsolete and will be remove in the next release.
+- Shares.Item2 property is obsolete and will be remove in the next release.
+
+### Removed
+- Removed .NET 5 support, because it retires on May 10, 2022. See [Microsoft .NET and .NET Core - Support Dates](https://docs.microsoft.com/en-us/lifecycle/products/microsoft-net-and-net-core).
+
 ## [0.7.0] - 2022-02-09
 ### Added
 - Added implicit casts for byte arrays in *Secret* class.
@@ -104,7 +126,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added LICENSE.md
 - Added README.md
 
-[Unreleased]: https://github.com/shinji-san/SecretSharingDotNet/compare/v0.4.2...HEAD
+[Unreleased]: https://github.com/shinji-san/SecretSharingDotNet/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/shinji-san/SecretSharingDotNet/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/shinji-san/SecretSharingDotNet/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/shinji-san/SecretSharingDotNet/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/shinji-san/SecretSharingDotNet/compare/v0.4.2...v0.5.0
 [0.4.2]: https://github.com/shinji-san/SecretSharingDotNet/compare/v0.4.1...v0.4.2
 [0.4.1]: https://github.com/shinji-san/SecretSharingDotNet/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/shinji-san/SecretSharingDotNet/compare/v0.3.0...v0.4.0