Miscellaneous Magical Modifications (#11)

- (Attempt at) Improving CI build and packaging
  - Updated GitHub actions / `NetDuid.csproj` to use parameterize version number
  - Now embedding tracked sources for Source Link
- Cleaned up README.MD to add missing info, and removed duplicate info

Author: rheone

.github/workflows/build.yml

@@ -37,7 +37,7 @@ jobs:
         run: dotnet restore ./src
 
       - name: Build
-        run: dotnet build ./src --no-restore
+        run: dotnet build ./src --no-restore -p:VersionFromCI="0.0.0-cibuild"
 
       - name: Test
         run: dotnet test ./src --no-build --verbosity normal

.github/workflows/publish.yml

@@ -20,24 +20,34 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: 9.0.x
+
+      - name: Extract version
+        id: extract_version
+        run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
+
       - name: Restore dotnet tools
         run: dotnet tool restore
+
       - name: Restore dependencies
         run: dotnet restore ./src
+
       - name: Build
-        run: dotnet build ./src --no-restore
-      - name: Extract version
-        id: extract_version
-        run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
+        run: dotnet build ./src --no-restore --configuration Release /p:VersionFromCI=${{ env.VERSION }}
+
       - name: Pack
-        run: dotnet pack ./src/NetDuid/NetDuid.csproj --configuration Release --no-build --output ./packages /p:PackageVersion=${{ env.VERSION }}
+        run: dotnet pack ./src/NetDuid/NetDuid.csproj --configuration Release --no-build --output ./packages /p:VersionFromCI=${{ env.VERSION }}
+
       - name: Publish to GitHub Packages
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: dotnet nuget push ./packages/*.nupkg --source "https://nuget.pkg.github.com/sandialabs/index.json" --api-key $GITHUB_TOKEN --skip-duplicate
-      - name: Publish to nuget.org Packages
-        run: dotnet nuget push ./packages/*.nupkg --source "https://api.nuget.org/v3/index.json" --api-key ${{ secrets.NUGET_ORG_APIKEY }} --skip-duplicate
+
+      - name: Publish to nuget.org
+        env:
+          NUGET_ORG_APIKEY: ${{ secrets.NUGET_ORG_APIKEY }}
+        run: dotnet nuget push ./packages/*.nupkg --source "https://api.nuget.org/v3/index.json" --api-key $NUGET_ORG_APIKEY --skip-duplicate

README.md

@@ -144,7 +144,7 @@ This project uses [Semantic Versioning](https://semver.org/)
 
 ### Targeting
 
-The project targets [.NET Standard 2.0](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0), [.NET 6](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6), [.NET 7](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-7), and [.NET 8](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-8). The test project similarly targets .NET 6, .NET 7, and .NET 8, but targets [.NET Framework 4.8](https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48) for the .NET Standard 2.0 tests.
+The project targets [.NET Standard 2.0](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0), [.NET 6](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6), [.NET 7](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-7), [.NET 8](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-8), and [.NET 9](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-9/overview). The test project similarly targets .NET 6, .NET 7, .NET 8, .NET 9, but targets [.NET Framework 4.8](https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48) for the .NET Standard 2.0 tests.
 
 ### Commit Hook
 
@@ -176,10 +176,11 @@ This project was built by the Production Tools Team at Sandia National Laborator
 
 Including, but not limited to:
 
-- Robert H. Engelhardt
+- [Robert H. Engelhardt](https://rheone.com/)
 - Drew Antonich
 - Stephen Jackson
 - Sterling Violette
+- Madison Brewer
 
 ## Copyright
 
@@ -189,6 +190,4 @@ Including, but not limited to:
 
 > Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 > http://www.apache.org/licenses/LICENSE-2.0
-> Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-
-This project is licensed under the terms of Contract DE-NA0003525 with NTESS. The U.S. Government retains certain rights in this software.
+> Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

dictionary.dic

@@ -1,4 +1,6 @@
 duid
 duids
 NetDuid
-undelimited
+NTESS
+Sandia
+undelimited

src/NetDuid.Tests/packages.lock.json

@@ -17,15 +17,6 @@
           "Microsoft.CodeCoverage": "17.12.0"
         }
       },
-      "Microsoft.NETFramework.ReferenceAssemblies": {
-        "type": "Direct",
-        "requested": "[1.0.3, )",
-        "resolved": "1.0.3",
-        "contentHash": "vUc9Npcs14QsyOD01tnv/m8sQUnGTGOw1BCmKcv77LBJY7OxhJ+zJF7UD/sCL3lYNFuqmQEVlkfS4Quif6FyYg==",
-        "dependencies": {
-          "Microsoft.NETFramework.ReferenceAssemblies.net48": "1.0.3"
-        }
-      },
       "Roslynator.Analyzers": {
         "type": "Direct",
         "requested": "[4.12.10, )",
@@ -89,11 +80,6 @@
         "resolved": "17.12.0",
         "contentHash": "4svMznBd5JM21JIG2xZKGNanAHNXplxf/kQDFfLHXQ3OnpJkayRK/TjacFjA+EYmoyuNXHo/sOETEfcYtAzIrA=="
       },
-      "Microsoft.NETFramework.ReferenceAssemblies.net48": {
-        "type": "Transitive",
-        "resolved": "1.0.3",
-        "contentHash": "zMk4D+9zyiEWByyQ7oPImPN/Jhpj166Ky0Nlla4eXlNL8hI/BtSJsgR8Inldd4NNpIAH3oh8yym0W2DrhXdSLQ=="
-      },
       "Microsoft.TestPlatform.ObjectModel": {
         "type": "Transitive",
         "resolved": "17.12.0",

src/NetDuid/NetDuid.csproj

@@ -6,8 +6,23 @@
     <OutputPath>bin\</OutputPath>
     <DocumentationFile>$(OutputPath)$(AssemblyName).xml</DocumentationFile>
     <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(VersionFromCI)'!=''">
+    <Version>$(VersionFromCI)</Version>
     <IsPackable>true</IsPackable>
   </PropertyGroup>
+  <PropertyGroup Condition="'$(VersionFromCI)'==''">
+    <Version>0.0.0-build</Version>
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">
+    <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(TF_BUILD)' == 'true'">
+    <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+  </PropertyGroup>
 
   <PropertyGroup>
     <Title>NetDuid</Title>
@@ -17,7 +32,6 @@
     <NeutralLanguage>en</NeutralLanguage>
     <PackageLanguage>en-US</PackageLanguage>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
-    <Version>1.0.0</Version>
     <Company>Sandia National Laboratories</Company>
     <Authors>The Production Tools Team</Authors>
     <Copyright>Copyright 2024 National Technology &amp; Engineering Solutions of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software</Copyright>
@@ -28,6 +42,7 @@
     <PackageProjectUrl>https://github.com/sandialabs/NetDuid</PackageProjectUrl>
     <RepositoryType>git</RepositoryType>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>