updates

Author: harald-tsys

.github/workflows/publish.yml

@@ -29,7 +29,7 @@ jobs:
             2.1.x
 
       - name: Build Package
-        run: dotnet pack --output nupkgs --include-source --include-symbols --configuration Release
+        run: dotnet pack --output nupkgs /p:ContinuousIntegrationBuild=true --configuration Release
 
       - name: Publish Package
         run: dotnet nuget push nupkgs/*.nupkg --source $NUGET_SOURCE_URL --api-key $GITHUB_TOKEN

buildtools/build.proj

@@ -35,7 +35,7 @@
     <Exec Command="dotnet restore $(SOLUTION_NAME)" WorkingDirectory=".." />
   </Target>
 
-  <Target Name="build-nuget-packages" DependsOnTargets="init">
+  <Target Name="build-nuget-packages" DependsOnTargets="init" Description="Build NuGet packages">
     <Exec
       Command="dotnet build $(SOLUTION_NAME) /t:Rebuild /p:Configuration=$(Configuration) /p:AssemblyOriginatorKeyFile=$(AssemblyOriginatorKeyFile) /p:SignAssembly=$(SignAssembly)"
       WorkingDirectory=".." />
@@ -58,11 +58,4 @@
       StdOutEncoding="utf-8" />
   </Target>
 
-  <Target Name="publish-nuget-github" DependsOnTargets="build-nuget-packages">
-    <Exec
-      Command="dotnet nuget push &quot;$(MSBuildThisFileDirectory)../Deployment/nuget-packages/*.nupkg&quot; --source &quot;github&quot; --skip-duplicate"
-      WorkingDirectory="$(MSBuildProjectDirectory)"
-      StdOutEncoding="utf-8" />
-  </Target>
-
 </Project>

doc/source/installation/_index.rst

@@ -7,7 +7,60 @@ Installation
 
 The latest state of the module can be installed directly from the GitHub repository.
 
-TBD.
+Install library from GitHub NuGet feed
+--------------------------------------
+
+.. note::
+
+   For details see: `GitHub Documentation <https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry>`_
+
+
+To authenticate to GitHub Packages with the dotnet command-line interface
+(CLI), create a nuget.config file in your project directory specifying
+GitHub Packages as a source under packageSources for the dotnet CLI client.
+
+You must replace:
+
+* USERNAME with the name of your personal account on GitHub.
+* TOKEN with your personal access token (classic).
+
+.. code-block:: xml
+   :caption: NuGet.Config
+
+    <?xml version="1.0" encoding="utf-8"?>
+    <configuration>
+        <packageSources>
+            <clear />
+            <add key="github" value="https://nuget.pkg.github.com/opentelekomcloud-community/index.json" />
+        </packageSources>
+        <packageSourceCredentials>
+            <github>
+                <add key="Username" value="USERNAME" />
+                <add key="ClearTextPassword" value="TOKEN" />
+            </github>
+        </packageSourceCredentials>
+    </configuration>
+
+
+Add or update package reference in the project file using the .NET CLI:
+
+.. code-block:: shell
+   :caption: dotnet add package
+
+    dotnet add package OpenTelekomCloud.API.Signing.Core --version 0.0.0-alpha.0
+
+Alternative add the package reference to your project file:
+
+.. code-block:: xml
+   :caption: YOUR_PROJECT.csproj
+
+    <project Sdk="Microsoft.NET.Sdk">
+
+      <ItemGroup>
+        <PackageReference Include="OpenTelekomCloud.API.Signing.Core" Version="*-*" />
+      </ItemGroup>
+
+    </project>
 
 
 Install dotnet on Ubuntu

otc-api-sign-sdk-core/otc-api-sign-sdk-core.csproj

@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <ItemGroup>
+    <!-- https://learn.microsoft.com/en-us/dotnet/standard/library-guidance/sourcelink -->
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
   </ItemGroup>
 
@@ -10,6 +11,10 @@
 
     <!-- Embed source files that are not tracked by the source control manager in the PDB -->
     <EmbedUntrackedSources>true</EmbedUntrackedSources>
+
+    <DebugType>embedded</DebugType>
+    <GitRepositoryRemoteName>github</GitRepositoryRemoteName>
+
   </PropertyGroup>
 
   <ItemGroup>
@@ -92,9 +97,6 @@
 
     <IncludeSource>true</IncludeSource>
 
-    <IncludeSymbols>true</IncludeSymbols>
-    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
-
   </PropertyGroup>
 
   <ItemGroup>

samples-doc/NuGet.Config

@@ -1,13 +1,9 @@
 <?xml version="1.0" encoding="utf-8"?>
 <configuration>
 
-<Settings>
-  <add key="protocolVersion" value="2" />
-</Settings>
-<!-- 
-  <solution>
-    <add key="disableSourceControlIntegration" value="true" />
-  </solution> -->
+  <Settings>
+    <add key="protocolVersion" value="2" />
+  </Settings>
 
   <packageSources>
 
@@ -23,11 +19,10 @@
 
   <packageSourceCredentials>
     <github>
-      <!-- <add key="Username" value="api-key" /> -->
       <add key="Username" value="%GITHUB_USERNAME%" />
       <add key="ClearTextPassword" value="%GITHUB_TOKEN%" />
     </github>
   </packageSourceCredentials>
-     
+
 
 </configuration>