Merge pull request #6 from soernt/develop

Develop

Author: soernt

.github/workflows/build_test_deploy.yml

@@ -46,11 +46,11 @@ jobs:
     - name: Build Release version
       run: dotnet build --no-restore --configuration Release /p:AssemblyVersion=${{ steps.gitversion.outputs.assemblySemFileVer }} /p:FileVersion=${{ steps.gitversion.outputs.assemblySemFileVer }} /p:InformationalVersion=${{ steps.gitversion.outputs.Sha }}
 
-#    - name: Run Tests
-#      run: dotnet test --configuration Release --no-restore --verbosity normal --collect:"XPlat Code Coverage" --settings Marten.AspNetCore.Identity.Tests/coverlet.runsettings
+    - name: Run Tests
+      run: dotnet test --no-restore --configuration Release --verbosity normal --collect:"XPlat Code Coverage" --settings Marten.AspNetCore.Identity.Tests/coverlet.runsettings
 
     - name: Pack
-      run: dotnet pack --no-build --output ./output --configuration Release /p:PackageVersion=${{ steps.gitversion.outputs.nuGetVersionV2 }}
+      run: dotnet pack --no-restore --no-build --configuration Release /p:PackageVersion=${{ steps.gitversion.outputs.nuGetVersionV2 }} --output ./output 
 
     - name: Upload Package to job as artificat
       uses: actions/upload-artifact@v2
@@ -61,7 +61,7 @@ jobs:
         if-no-files-found: error
 
     - name: Upload Package to release
-      # if: contains(github.ref, 'main')
+      if: contains(github.ref, 'main')
       uses: svenstaro/upload-release-action@v1-release
       with:
         repo_token: ${{ secrets.GITHUB_TOKEN }}
@@ -72,5 +72,5 @@ jobs:
         overwrite: true
 
     - name: Upload Package to nuget
-      # if: contains(github.ref, 'main')
+      if: contains(github.ref, 'main')
       run: dotnet nuget push ./output/*.nupkg --source $NUGET_FEED --skip-duplicate --api-key ${{ secrets.NUGET_KEY }}

README.md

@@ -1,4 +1,39 @@
-![build](https://github.com/soernt/AspNetCore.Identity.Marten/actions/workflows/build_and_test.yml/badge.svg)
+![build](https://github.com/soernt/AspNetCore.Identity.Marten/actions/workflows/build_test_deploy.yml/badge.svg)
 
 # AspNetCore.Identity.Marten
 .Net Core Identity Stores using Marten
+
+The users and roles stores are tested by using the offical Microsoft.AspNetCore.Identity.Specification.Tests packages. Have a look at the Marten.AspNetCore.Identity.Tests project. 
+To run the tests you should have docker installed. A PostgreSQL image will be automatically downloaded and used during the test. 
+
+ 
+# How to configure it
+
+This repository has a small example project which setup the Microsoft Identity to use this package.
+
+
+1. Add this [package](https://www.nuget.org/packages/Marten.AspNetCore.Identity/) to your project.
+
+2. While adding the default Marten support, you should configure the MartenIdentityUser and MartenIdentityRole entities:
+```c#
+builder.Services.AddMarten(options =>
+{
+    options.Connection(builder.Configuration.GetConnectionString("Marten"));
+    // Configure the MartenIdentityUser and MartenIdentityRole mappings
+    options.ConfigureMartenIdentityMapping();
+    if (builder.Environment.IsDevelopment())
+    {
+        options.AutoCreateSchemaObjects = AutoCreate.All;
+    }
+});
+```
+
+3. Add the MartenIdentityStores
+```c#
+builder.Services.AddMartenIdentityStores();
+```
+
+4. Configure the default identity to be MartenIdentityUser.
+```c#
+builder.Services.AddDefaultIdentity<MartenIdentityUser>();
+```

source/Marten.AspNetCore.Identity/Marten.AspNetCore.Identity.csproj

@@ -10,6 +10,7 @@
         <Authors>Sörnt Poppe</Authors>
         <PackageTitle>Marten.AspNetCore.Identity</PackageTitle>
         <Description>A Marten UserStore and RoleStore adapter for Microsoft.Extensions.Identity.Core 6.</Description>
+         <PackageReadmeFile>README.md</PackageReadmeFile>
         <PackageProjectUrl>http://www.opensource.org/licenses/mit-license.php</PackageProjectUrl>
         <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
         <Copyright>Copyright 2021 (c) Sörnt Poppe. All rights reserved.</Copyright>
@@ -21,6 +22,10 @@
         -->
     </PropertyGroup>
 
+     <ItemGroup>
+        <None Include="../../README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
+
     <PropertyGroup>
         <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
     </PropertyGroup>