Merge pull request #12 from AinoraZ/AZ/feat/release-ci

Added Github Action for Package Release

Author: AinoraZ

.github/workflows/release.yml

@@ -0,0 +1,55 @@
+on:
+  release:
+    types: [published]
+
+env:
+  NUGET_FEED: https://api.nuget.org/v3/index.json
+  # Only tests subset of versioning for this repository: major.minor.patch and major.minor.patch-prerelease.prenum
+  RELEASE_REGEX: ^([0-9]+)\.([0-9]+)\.([0-9]+)(-([a-z]+)\.([0-9]+))?$
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        dotnet-version: ["6.0.x"]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: Setup dotnet ${{ matrix.dotnet-version }}
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: ${{ matrix.dotnet-version }}
+    - name: Set VERSION variable from tag
+      id: tag_version
+      run: echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/v}
+    - name: Check version validity
+      run: |
+        if [[ "${VERSION}" =~ ${RELEASE_REGEX} ]]; then
+          echo "Release version: ${VERSION}"
+          exit 0
+        else
+          echo "Invalid version: ${VERSION}"
+          exit 1
+        fi
+      env:
+        VERSION: ${{ steps.tag_version.outputs.VERSION }}
+    - name: Build Release
+      run: dotnet build --configuration Release /p:Version="${VERSION}"
+      env:
+        VERSION: ${{ steps.tag_version.outputs.VERSION }}
+    - name: Test Release
+      run: dotnet test --configuration Release --no-build
+    - name: Pack
+      run: dotnet pack --configuration Release /p:Version="${VERSION}" --include-symbols --no-build --output packed/
+      env:
+        VERSION: ${{ steps.tag_version.outputs.VERSION }}
+    - name: Push
+      run: dotnet nuget push packed/*.nupkg --source ${NUGET_FEED} --api-key ${NUGET_KEY} --skip-duplicate
+      env:
+        NUGET_KEY: ${{ secrets.NUGET_KEY }}
+

.vscode/settings.json

@@ -4,6 +4,7 @@
         "Buildable",
         "Diagnoser",
         "Includable",
+        "prenum", // prerelease number
         "Xunit"
     ]
 }

README.md

@@ -1,6 +1,6 @@
 # EFCore.IncludeBuilder
 
-Extension library for Entity Framework Core that tries to improve upon the ```Include(...).ThenInclude(...)``` syntax to better support the following scenarios:
+Extension library for Entity Framework Core that tries to improve upon the ```Include(...).ThenInclude(...)``` syntax in order to better support the following scenarios:
 
 - Loading multiple entities on the same level (siblings).
 - Writing extension methods to include a whole set of entities at once.
@@ -9,7 +9,7 @@ Extension library for Entity Framework Core that tries to improve upon the ```In
 
 EFCore.IncludeBuilder allows you to load sibling entities without going up the whole include structure.
 
-UseIncludeBuilder() syntax:
+```UseIncludeBuilder()``` syntax:
 
 ```csharp
 dbContext.Users
@@ -26,7 +26,7 @@ dbContext.Users
     .Build()
 ```
 
-Include(...).ThenInclude(...) syntax:
+```Include(...).ThenInclude(...)``` syntax:
 
 ```csharp
 dbContext.Users
@@ -86,7 +86,7 @@ dbContext.Users
 
 ## How It Works
 
-EFCore.IncludeBuilder converts the includes You give it back to ```Include(...).ThenInclude(...)``` calls, so it *should* support all the same providers and functionality as the original.
+EFCore.IncludeBuilder converts the includes you give it back to ```Include(...).ThenInclude(...)``` calls, so it *should* support all the same providers and functionality as the original.
 
 ## Performance
 
@@ -104,10 +104,3 @@ For larger queries that duplicate the same filters, it can even be the faster op
 |        UseIncludeBuilder | 164.3 μs | 0.39 μs | 0.36 μs |  1.08 | 1.7090 | 0.4883 |     35 KB |
 
 You can find the most up to date benchmarks in the build artifacts for each build.
-
-## TODO
-
-This project is still in progress, so the public interfaces are subject to change.
-
-- [X] Propose adoption to efcore (seems to be in consideration [#23110](https://github.com/dotnet/efcore/issues/23110)).
-- [ ] Publish package as third-party library for the meanwhile.

src/Ainoraz.EFCore.IncludeBuilder/Ainoraz.EFCore.IncludeBuilder.csproj

@@ -5,6 +5,19 @@
 		<PublishRepositoryUrl>true</PublishRepositoryUrl>
 	</PropertyGroup>
 
+	<PropertyGroup>
+		<PackageId>Ainoraz.EFCore.IncludeBuilder</PackageId>
+		<Authors>ainoraz</Authors>
+		<Product>$(PackageId)</Product>
+		<PackageProjectUrl>https://github.com/AinoraZ/EFCore.IncludeBuilder</PackageProjectUrl>
+		<RepositoryUrl>https://github.com/AinoraZ/EFCore.IncludeBuilder.git</RepositoryUrl>
+		<RepositoryType>git</RepositoryType>
+		<PackageTags>efcore;entity;framework;core;include;builder;improved;syntax;</PackageTags>
+		<PackageLicenseExpression>MIT</PackageLicenseExpression>
+		<PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
+		<Description>Extension library for Entity Framework Core that makes loading navigation properties easier.</Description>
+	</PropertyGroup>
+
 	<ItemGroup Label="Package References">
 		<PackageReference Include="Microsoft.SourceLink.GitHub" PrivateAssets="all" Version="1.1.1" />
 		<PackageReference Include="Microsoft.EntityFrameworkCore" Version="$(EFCoreVersion)" />