Added nuspec; version added from workflow through csproj params (LEGO#15)

alex-dubrovskyi · web-flow · commit 963e2fd75ae3 · 2022-03-15T08:48:45.000+01:00
* package both AsyncAPI and AsyncAPI.Readers projects
diff --git a/.github/workflows/release-package.yml b/.github/workflows/release-package.yml
@@ -2,7 +2,8 @@ name: Publish a NuGet package
 on:
   push:
     branches: [ main ]
-    paths: 
+    paths:
+      - 'src/LEGO.AsyncAPI/**'
       - 'src/LEGO.AsyncAPI.Readers/**'
       - ".github/workflows/release-package.yml"
       - '!**/*.md' 
@@ -24,8 +25,14 @@ jobs:
           NUGET_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}   
       
       - name: Build LEGO.AsyncAPI project and pack NuGet package
-        run: dotnet pack src/LEGO.AsyncAPI.Readers/LEGO.AsyncAPI.Readers.csproj -c Release -o out -p:PackageVersion=1.0.$GITHUB_RUN_ID
+        run: dotnet pack src/LEGO.AsyncAPI/LEGO.AsyncAPI.csproj -c Release -o out -p:PackageVersion=1.0.$GITHUB_RUN_ID.$GITHUB_RUN_NUMBER
 
       - name: Push generated package to GitHub Packages registry
-        run: dotnet nuget push out/*.nupkg --skip-duplicate --no-symbols true --api-key ${{secrets.GITHUB_TOKEN}}
+        run: dotnet nuget push out/*.nupkg --skip-duplicate -n --api-key ${{secrets.GITHUB_TOKEN}}
+
+      - name: Build LEGO.AsyncAPI.Readers project and pack NuGet package
+        run: dotnet pack src/LEGO.AsyncAPI.Readers/LEGO.AsyncAPI.Readers.csproj -c Release -o out_readers -p:PackageVersion=1.0.$GITHUB_RUN_ID.$GITHUB_RUN_NUMBER
+
+      - name: Push generated package to GitHub Packages registry
+        run: dotnet nuget push out_readers/*.nupkg --skip-duplicate -n --api-key ${{secrets.GITHUB_TOKEN}}
              
diff --git a/README.md b/README.md
@@ -4,6 +4,24 @@
 
 Serialization and Deserialization of json/yaml AsyncAPI specifications into dotnet classes.
 
+
+## Getting started
+
+1. Read Async API specification [here](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md)
+2. Explore [example projects](https://github.com/LEGO/AsyncAPI.NET/tree/main/examples). 
+3. Add dependency to LEGO.AsyncAPI.Readers Nuget package in order to transform your Async API specs into AsyncApiDocument C# object.
+	- Download Nuget.exe
+	- Run	
+	nuget.exe sources Add -Name "LEGO GitHub Package Registry" -Source https://nuget.pkg.github.com/lego/index.json -username {your lego email} -password {your Github PAT with packages-read permission and SSO enabled}
+	- Add latest release version of package LEGO.AsyncAPI.Readers to your .Net project.
+4. Contribute following the [contribution guide](CONTRIBUTION.md).
+
+
 ## Contribution
 
-Do you want to contribute to the project? Find out how [here](CONTRIBUTION.md)
+Do you want to contribute to the project? Find out how [here](CONTRIBUTION.md).
+
+
+## License
+
+AsyncAPI.Net is copyright LEGO Group.
diff --git a/src/LEGO.AsyncAPI.Readers/LEGO.AsyncAPI.Readers.csproj b/src/LEGO.AsyncAPI.Readers/LEGO.AsyncAPI.Readers.csproj
@@ -4,7 +4,15 @@
     <TargetFramework>net6.0</TargetFramework>
     <ImplicitUsings>disable</ImplicitUsings>
     <Nullable>disable</Nullable>
-  </PropertyGroup>
+	<PackageProjectUrl>https://github.com/LEGO/AsyncAPI.NET</PackageProjectUrl>
+	<Description>AsyncAPI.NET Readers for JSON and YAML documents</Description>
+	<PackageTags>AsyncAPI .NET</PackageTags>
+	<PackageId>LEGO.AsyncAPI.Readers</PackageId>
+	<Version>1.0.0</Version>
+	<AssemblyName>LEGO.AsyncAPI.Readers</AssemblyName>
+	<RootNamespace>LEGO.AsyncAPI.Readers</RootNamespace>
+	<RepositoryUrl>https://github.com/LEGO/AsyncAPI.NET</RepositoryUrl>
+  </PropertyGroup>	
 
   <ItemGroup>
     <None Remove="stylecop.json" />
@@ -24,11 +32,11 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\LEGO.AsyncAPI\LEGO.AsyncAPI.csproj" />
+    <InternalsVisibleTo Include="LEGO.AsyncAPI.Tests" />
   </ItemGroup>
 
   <ItemGroup>
-    <InternalsVisibleTo Include="LEGO.AsyncAPI.Tests" />
+    <ProjectReference Include="..\LEGO.AsyncAPI\LEGO.AsyncAPI.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/src/LEGO.AsyncAPI/LEGO.AsyncAPI.csproj b/src/LEGO.AsyncAPI/LEGO.AsyncAPI.csproj
@@ -3,6 +3,14 @@
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
     <ImplicitUsings>disable</ImplicitUsings>
+	<PackageProjectUrl>https://github.com/LEGO/AsyncAPI.NET</PackageProjectUrl>
+	<Description>AsyncAPI.NET models</Description>
+	<PackageTags>AsyncAPI .NET</PackageTags>
+	<PackageId>LEGO.AsyncAPI</PackageId>
+	<Version>1.0.0</Version>
+	<AssemblyName>LEGO.AsyncAPI</AssemblyName>
+	<RootNamespace>LEGO.AsyncAPI</RootNamespace>
+	<RepositoryUrl>https://github.com/LEGO/AsyncAPI.NET</RepositoryUrl>
   </PropertyGroup>
 
   <ItemGroup>
