Integrate with Nerdbank.GitVersioning

Renci.SshNet.sln

@@ -25,6 +25,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		README.md = README.md
 		stylecop.json = stylecop.json
 		THIRD-PARTY-NOTICES.TXT = THIRD-PARTY-NOTICES.TXT
+		version.json = version.json
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{D21A4D03-0AC2-4613-BB6D-74D2D16A72CC}"

nuget.config

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <clear />
+    <add key="nuget" value="https://api.nuget.org/v3/index.json" />
+    <add key="andrewarnott" value="https://pkgs.dev.azure.com/andrewarnott/OSS/_packaging/PublicCI/nuget/v3/index.json" />
+  </packageSources>
+
+    <!-- Define mappings by adding package patterns beneath the target source. -->
+    <!-- Nerdbank.GitVersioning will be restored from its CI feed, everything else from nuget.org. -->
+    <packageSourceMapping>
+        <!-- key value for <packageSource> should match key values from <packageSources> element -->
+        <packageSource key="nuget">
+            <package pattern="*" />
+        </packageSource>
+        <packageSource key="andrewarnott">
+            <package pattern="Nerdbank.GitVersioning" />
+        </packageSource>
+    </packageSourceMapping>
+</configuration>

src/Renci.SshNet/Renci.SshNet.csproj

@@ -10,7 +10,6 @@
   <PropertyGroup>
     <PackageId>SSH.NET</PackageId>
     <Title>SSH.NET</Title>
-    <Version>2024.0.0</Version>
     <Description>SSH.NET is a Secure Shell (SSH) library for .NET, optimized for parallelism.</Description>
     <Copyright>Copyright © Renci 2010-$([System.DateTime]::UtcNow.Year)</Copyright>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
@@ -21,6 +20,7 @@
     <PackageReleaseNotes>https://github.com/sshnet/SSH.NET/releases/tag/$(Version)</PackageReleaseNotes>
     <IncludeSymbols>True</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <NBGV_ThisAssemblyIncludesPackageVersion>true</NBGV_ThisAssemblyIncludesPackageVersion>
   </PropertyGroup>
 
   <PropertyGroup Condition=" $([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0')) ">
@@ -32,6 +32,16 @@
   <PropertyGroup Condition=" '$(TargetFramework)' == 'net462' ">
     <DefineConstants>$(DefineConstants);FEATURE_BINARY_SERIALIZATION</DefineConstants>
   </PropertyGroup>
+
+  <ItemGroup>
+    <!--
+    3.7.57-alpha comes from the project's CI feed as defined in nuget.config,
+    in order to pick up https://github.com/dotnet/Nerdbank.GitVersioning/pull/1029.
+    When a newer version is published to nuget.org, update the version here and delete
+    nuget.config (or just the CI feed).
+    -->
+    <PackageReference Include="Nerdbank.GitVersioning" Version="3.7.57-alpha" PrivateAssets="all" />
+  </ItemGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'net462' or '$(TargetFramework)' == 'netstandard2.0' ">
     <!-- Must be kept at version 1.0.0 or higher, see https://github.com/sshnet/SSH.NET/pull/1288 for details. -->

src/Renci.SshNet/Session.cs

@@ -558,7 +558,7 @@ internal Session(ConnectionInfo connectionInfo, IServiceFactory serviceFactory,
                 throw new ArgumentNullException(nameof(socketFactory));
             }
 
-            ClientVersion = "SSH-2.0-Renci.SshNet.SshClient.0.0.1";
+            ClientVersion = "SSH-2.0-Renci.SshNet.SshClient." + ThisAssembly.NuGetPackageVersion;
             ConnectionInfo = connectionInfo;
             _serviceFactory = serviceFactory;
             _socketFactory = socketFactory;

test/Renci.SshNet.Tests/Classes/Connection/ProtocolVersionExchangeTest_ServerResponseContainsNullCharacter.cs

@@ -52,7 +52,7 @@ public void Cleanup()
 
         protected void Arrange()
         {
-            _clientVersion = "SSH-2.0-Renci.SshNet.SshClient.0.0.1";
+            _clientVersion = "SSH-2.0-Renci.SshNet.SshClient." + ThisAssembly.NuGetPackageVersion;
             _timeout = TimeSpan.FromSeconds(5);
             _serverEndPoint = new IPEndPoint(IPAddress.Loopback, 8122);
             _dataReceivedByServer = new List<byte>();

test/Renci.SshNet.Tests/Classes/Connection/ProtocolVersionExchangeTest_ServerResponseInvalid_SshIdentificationOnlyContainsProtocolVersion.cs

@@ -54,7 +54,7 @@ public void Cleanup()
 
         protected void Arrange()
         {
-            _clientVersion = "SSH-2.0-Renci.SshNet.SshClient.0.0.1";
+            _clientVersion = "SSH-2.0-Renci.SshNet.SshClient." + ThisAssembly.NuGetPackageVersion;
             _timeout = TimeSpan.FromSeconds(5);
             _serverEndPoint = new IPEndPoint(IPAddress.Loopback, 8122);
             _dataReceivedByServer = new List<byte>();

test/Renci.SshNet.Tests/Classes/Connection/ProtocolVersionExchangeTest_ServerResponseValid_Comments.cs

@@ -52,7 +52,7 @@ public void Cleanup()
 
         protected void Arrange()
         {
-            _clientVersion = "SSH-2.0-Renci.SshNet.SshClient.0.0.1";
+            _clientVersion = "SSH-2.0-Renci.SshNet.SshClient." + ThisAssembly.NuGetPackageVersion;
             _timeout = TimeSpan.FromSeconds(5);
             _serverEndPoint = new IPEndPoint(IPAddress.Loopback, 8122);
             _dataReceivedByServer = new List<byte>();

test/Renci.SshNet.Tests/Classes/Connection/ProtocolVersionExchangeTest_ServerResponseValid_TerminatedByLineFeedWithoutCarriageReturn.cs

@@ -53,7 +53,7 @@ public void Cleanup()
 
         protected void Arrange()
         {
-            _clientVersion = "SSH-2.0-Renci.SshNet.SshClient.0.0.1";
+            _clientVersion = "SSH-2.0-Renci.SshNet.SshClient." + ThisAssembly.NuGetPackageVersion;
             _timeout = TimeSpan.FromSeconds(5);
             _serverEndPoint = new IPEndPoint(IPAddress.Loopback, 8122);
             _dataReceivedByServer = new List<byte>();

test/Renci.SshNet.Tests/Classes/Connection/ProtocolVersionExchangeTest_TimeoutReadingIdentificationString.cs

@@ -52,7 +52,7 @@ public void Cleanup()
 
         protected void Arrange()
         {
-            _clientVersion = "SSH-2.0-Renci.SshNet.SshClient.0.0.1";
+            _clientVersion = "SSH-2.0-Renci.SshNet.SshClient." + ThisAssembly.NuGetPackageVersion;
             _timeout = TimeSpan.FromMilliseconds(200);
             _serverEndPoint = new IPEndPoint(IPAddress.Loopback, 8122);
             _dataReceivedByServer = new List<byte>();

test/Renci.SshNet.Tests/Classes/SessionTest_ConnectToServerFails.cs

@@ -53,7 +53,7 @@ protected override void Act()
         [TestMethod]
         public void ClientVersionIsRenciSshNet()
         {
-            Assert.AreEqual("SSH-2.0-Renci.SshNet.SshClient.0.0.1", _session.ClientVersion);
+            Assert.AreEqual("SSH-2.0-Renci.SshNet.SshClient." + ThisAssembly.NuGetPackageVersion, _session.ClientVersion);
         }
 
         [TestMethod]

test/Renci.SshNet.Tests/Classes/SessionTest_Connected.cs

@@ -27,7 +27,7 @@ protected override void Act()
         [TestMethod]
         public void ClientVersionIsRenciSshNet()
         {
-            Assert.AreEqual("SSH-2.0-Renci.SshNet.SshClient.0.0.1", Session.ClientVersion);
+            Assert.AreEqual("SSH-2.0-Renci.SshNet.SshClient." + ThisAssembly.NuGetPackageVersion, Session.ClientVersion);
         }
 
         [TestMethod]

test/Renci.SshNet.Tests/Classes/SessionTest_NotConnected.cs

@@ -29,7 +29,7 @@ protected override void Act()
         [TestMethod]
         public void ClientVersionIsRenciSshNet()
         {
-            Assert.AreEqual("SSH-2.0-Renci.SshNet.SshClient.0.0.1", _session.ClientVersion);
+            Assert.AreEqual("SSH-2.0-Renci.SshNet.SshClient." + ThisAssembly.NuGetPackageVersion, _session.ClientVersion);
         }
 
         [TestMethod]

version.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json",
+  "version": "2024.0.0",
+  "publicReleaseRefSpec": [
+      "^refs/heads/master$", // we release out of master
+      "^refs/tags/\\d{4}\\.\\d+\\.\\d+(-beta\\d+)?$" // we also release tags starting with year.minor.build[-betaN]
+  ],
+  "cloudBuild": {
+    "buildNumber": {
+      "enabled": true
+    }
+  },
+  "assemblyVersion": {
+    "precision": "minor"
+  },
+  "nugetPackageVersion": {
+   "precision": "minor"
+  },
+  "release": {
+    "tagName" : "{version}",
+    "branchName" : "master",
+    "versionIncrement" : "build",
+    "firstUnstableTag" : "beta"
+  }
+}