Integrate with Nerdbank.GitVersioning #1299

scott-xu · 2024-01-29T14:19:23Z

No description provided.

IncludeSymbols

Co-authored-by: Rob Hague <rob.hague00@gmail.com>

…his particular project needs versioning. include package version in ThisAssembly and use nuget package version for the SSH client version. Since we define the precision of nuget package to "build", it has 3 digits. Nuget package version is unique which should be suffient.

Rob-Hague · 2024-01-31T12:15:29Z

I get a weird error when building this branch

1>C:\Users\rhague\.nuget\packages\nerdbank.gitversioning\3.7.48-alpha\build\Nerdbank.GitVersioning.Inner.targets(17,5): error MSB4018: The "Nerdbank.GitVersioning.Tasks.GetBuildVersion" task failed unexpectedly.
1>C:\Users\rhague\.nuget\packages\nerdbank.gitversioning\3.7.48-alpha\build\Nerdbank.GitVersioning.Inner.targets(17,5): error MSB4018: Nerdbank.GitVersioning.GitException: Got a com instead of a tag when opening object 1c7166a002d7633fe1595b3df4634ba0ef6e3138
1>C:\Users\rhague\.nuget\packages\nerdbank.gitversioning\3.7.48-alpha\build\Nerdbank.GitVersioning.Inner.targets(17,5): error MSB4018:    at Nerdbank.GitVersioning.ManagedGit.GitRepository.TryGetObjectByPath(GitObjectId sha, String objectType, Stream& value)
1>C:\Users\rhague\.nuget\packages\nerdbank.gitversioning\3.7.48-alpha\build\Nerdbank.GitVersioning.Inner.targets(17,5): error MSB4018:    at Nerdbank.GitVersioning.ManagedGit.GitRepository.TryGetObjectBySha(GitObjectId sha, String objectType, Stream& value)
1>C:\Users\rhague\.nuget\packages\nerdbank.gitversioning\3.7.48-alpha\build\Nerdbank.GitVersioning.Inner.targets(17,5): error MSB4018:    at Nerdbank.GitVersioning.ManagedGit.GitRepository.<LookupTags>g__HandleCandidate|44_0(GitObjectId pointsAt, String tagName, Boolean isPeeled, <>c__DisplayClass44_0& )
1>C:\Users\rhague\.nuget\packages\nerdbank.gitversioning\3.7.48-alpha\build\Nerdbank.GitVersioning.Inner.targets(17,5): error MSB4018:    at Nerdbank.GitVersioning.ManagedGit.GitRepository.LookupTags(GitObjectId objectId)
1>C:\Users\rhague\.nuget\packages\nerdbank.gitversioning\3.7.48-alpha\build\Nerdbank.GitVersioning.Inner.targets(17,5): error MSB4018:    at Nerdbank.GitVersioning.Managed.ManagedGitContext.get_HeadTags()
1>C:\Users\rhague\.nuget\packages\nerdbank.gitversioning\3.7.48-alpha\build\Nerdbank.GitVersioning.Inner.targets(17,5): error MSB4018:    at Nerdbank.GitVersioning.VersionOracle..ctor(GitContext context, ICloudBuild cloudBuild, Nullable`1 overrideVersionHeightOffset)
1>C:\Users\rhague\.nuget\packages\nerdbank.gitversioning\3.7.48-alpha\build\Nerdbank.GitVersioning.Inner.targets(17,5): error MSB4018:    at Nerdbank.GitVersioning.Tasks.GetBuildVersion.ExecuteInner() in D:\a\1\s\src\Nerdbank.GitVersioning.Tasks\GetBuildVersion.cs:line 240
1>C:\Users\rhague\.nuget\packages\nerdbank.gitversioning\3.7.48-alpha\build\Nerdbank.GitVersioning.Inner.targets(17,5): error MSB4018:    at Microsoft.Build.BackEnd.TaskExecutionHost.Microsoft.Build.BackEnd.ITaskExecutionHost.Execute()
1>C:\Users\rhague\.nuget\packages\nerdbank.gitversioning\3.7.48-alpha\build\Nerdbank.GitVersioning.Inner.targets(17,5): error MSB4018:    at Microsoft.Build.BackEnd.TaskBuilder.<ExecuteInstantiatedTask>d__26.MoveNext()

Rob-Hague · 2024-01-31T17:09:12Z

I get a weird error when building this branch

It seems to be a bug in the Nerdbank package, where it does not correctly handle lightweight tags in .git/ref/tags (e.g. 2023.0.1).

In a fresh clone, the tags are in .git/packed-refs which are handled correctly, hence it passing in CI. In my local copy of the repo, the tags are in .git/ref/tags and it is assuming they are all annotated tags.

scott-xu · 2024-02-16T14:36:20Z

It updates the CI build number:

Rob-Hague · 2024-02-16T18:40:09Z

I've not forgotten about this PR, I just want to read up some more on the configuration

Rob-Hague

I noticed that 2024.0.0 already has the commit info tagged to the dll (probably because of sourcelink?):

In that case, I am not sure if there still benefits to this change. I am not sure the release process needs to change (it seems simple enough), but as I don't make the releases I think I will have to defer to @WojciechNagorski as to whether to take this change.

version.json

Rob-Hague · 2024-02-24T16:33:05Z

version.json

+  },
+  "release": {
+    "tagName" : "{version}",
+    "branchName" : "master",


I think this should be e.g.

Suggested change

"branchName" : "master",

"branchName" : "release/{version}",

I think the curernt release is based on master branch with tag?

scott-xu · 2024-02-25T07:24:18Z

Not very familar with current release process, but it seems to be some manual work?

WojciechNagorski · 2024-02-25T07:30:28Z

Yes it is manual

scott-xu · 2024-02-25T07:32:03Z

I guess the current release process is based on https://github.com/sshnet/BuildTools and https://github.com/sshnet/SSH.NET/blob/develop/build/build.proj, am I right? @WojciechNagorski
No matter merge this PR or not, I recommend delegating the release process to appveyor

WojciechNagorski · 2024-02-25T09:59:34Z

Currently it is just dotnet pack right now.

Rob-Hague · 2024-07-26T17:03:59Z

I actually have some local changes for this, let me fix the merge and push them in

- Remove the "release" section. I don't think we will use that for now - Remove the "cloudBuild" section. Changing the CI build number doesn't seem that useful - In the "nugetPackageVersion" section: - Remove "precision". It defaults to build - Add "semVer"=2. This makes the package version e.g. 2024.1.1-prerelease.1 instead of 2024.1.1-prerelease-0001 - In "assemblyVersion" change "precision" to revision. Doesn't seem to change anything, I was just copying nbgv's setup: https://github.com/dotnet/Nerdbank.GitVersioning/blob/main/version.json - Make sure there are no '-' in the softwareversion string (change the test to a regex)

Rob-Hague · 2024-07-26T18:58:12Z

Example on a PR branch:

internal static partial class ThisAssembly {
    internal const string AssemblyConfiguration = "Release";
    internal const string AssemblyFileVersion = "2024.1.1";
    internal const string AssemblyInformationalVersion = "2024.1.1-prerelease.2+84ff4f6671";
    internal const string AssemblyName = "Renci.SshNet";
    internal const string AssemblyTitle = "SSH.NET";
    internal const string AssemblyVersion = "2024.1.1.0";
    internal static readonly global::System.DateTime GitCommitDate = new global::System.DateTime(638576102900000000L, global::System.DateTimeKind.Utc);
    internal const string GitCommitId = "84ff4f66711638341a0d856299f7a62ae4bbf38b";
    internal const bool IsPrerelease = true;
    internal const bool IsPublicRelease = false;
    internal const string NuGetPackageVersion = "2024.1.1-prerelease.2.g84ff4f6671";
    internal const string PublicKey = "0024000004800000940000000602000000240000525341310004000001000100f9194e1eb66b7e2575aaee115ee1d27bc100920e7150e43992d6f668f9737de8b9c7ae892b62b8a36dd1d57929ff1541665d101dc476d6e02390846efae7e5186eec409710fdb596e3f83740afef0d4443055937649bc5a773175b61c57615dac0f0fd10f52b52fedf76c17474cc567b3f7a79de95dde842509fb39aaf69c6c2";
    internal const string PublicKeyToken = "1cee9f8bde3db106";
    internal const string RootNamespace = "Renci.SshNet";
}

Example on a simulated "public" branch e.g. develop:

internal static partial class ThisAssembly {
    internal const string AssemblyConfiguration = "Release";
    internal const string AssemblyFileVersion = "2024.1.1";
    internal const string AssemblyInformationalVersion = "2024.1.1-prerelease.3+57319f736f";
    internal const string AssemblyName = "Renci.SshNet";
    internal const string AssemblyTitle = "SSH.NET";
    internal const string AssemblyVersion = "2024.1.1.0";
    internal static readonly global::System.DateTime GitCommitDate = new global::System.DateTime(638576099590000000L, global::System.DateTimeKind.Utc);
    internal const string GitCommitId = "57319f736f1d0dbf25455f121669223d8fc48893";
    internal const bool IsPrerelease = true;
    internal const bool IsPublicRelease = true;
    internal const string NuGetPackageVersion = "2024.1.1-prerelease.3";
    internal const string PublicKey = "0024000004800000940000000602000000240000525341310004000001000100f9194e1eb66b7e2575aaee115ee1d27bc100920e7150e43992d6f668f9737de8b9c7ae892b62b8a36dd1d57929ff1541665d101dc476d6e02390846efae7e5186eec409710fdb596e3f83740afef0d4443055937649bc5a773175b61c57615dac0f0fd10f52b52fedf76c17474cc567b3f7a79de95dde842509fb39aaf69c6c2";
    internal const string PublicKeyToken = "1cee9f8bde3db106";
    internal const string RootNamespace = "Renci.SshNet";
}

Rob-Hague · 2024-07-27T11:54:02Z

The appveyor nuget feed is in operation:

scott-xu and others added 24 commits December 2, 2023 10:09

GeneratePackageOnBuild

317c38c

IncludeSymbols

Add packages to artifacts

4eb2360

Merge branch 'develop' into generate-nuget-package

1593dd2

Merge branch 'develop' into generate-nuget-package

3c0f4ed

Update src/Renci.SshNet/Renci.SshNet.csproj

f33918a

Co-authored-by: Rob Hague <rob.hague00@gmail.com>

Merge branch 'develop' into generate-nuget-package

8bad9d6

Merge branch 'develop' into generate-nuget-package

e58ae57

Update Renci.SshNet.csproj

2a74e7a

Co-authored-by: Rob Hague <rob.hague00@gmail.com>

Merge branch 'develop' into generate-nuget-package

2b47495

Merge branch 'develop' into generate-nuget-package

83f522d

Merge branch 'develop' into generate-nuget-package

dc4deb3

Delete build/nuget/SSH.NET.nuspec

faae7d6

Delete SSH.NET.nuspec from .sln file

196789c

Merge branch 'develop' into generate-nuget-package

f0af300

Update Renci.SshNet.csproj

28ad3c1

Update build.proj

366c324

init nbgv

3efc902

Merge branch 'generate-nuget-package' into nbgv

f4c3015

Include version.json in "Solution Items"

04a8c89

Merge branch 'sshnet:develop' into nbgv

8ee48a4

Update Directory.Build.props

2536152

define publicReleaseRefSpec

be998ee

update version.json

8035be2

update version.json

6b533b6

scott-xu requested review from drieseng and WojciechNagorski as code owners January 29, 2024 14:19

scott-xu mentioned this pull request Jan 29, 2024

Infrastructure work items #1259

Open

4 tasks

scott-xu added 3 commits January 29, 2024 22:36

set cloud build number

edf8dc6

fix sshnet#1292

e82fc75

remove unexpected code format

ea14cbe

scott-xu added 2 commits January 30, 2024 21:44

Delete version from csproj

4585507

scott-xu marked this pull request as ready for review January 30, 2024 14:48

Rob-Hague mentioned this pull request Feb 1, 2024

Error in ManagedGit when dealing with non-packed lightweight tags dotnet/Nerdbank.GitVersioning#1026

Closed

Rob-Hague and others added 3 commits February 3, 2024 20:27

Use package from CI feed

1fc5c65

Merge branch 'develop' into nbgv

3c6a3e1

Merge branch 'develop' into nbgv

a7905b8

Merge remote-tracking branch 'upstream/develop' into nbgv

b5d92f3

Rob-Hague reviewed Feb 24, 2024

View reviewed changes

Bump version to 2024.0.1; Update version precision

7f4a63e

scott-xu marked this pull request as draft July 26, 2024 13:25

Merge remote-tracking branch 'upstream/develop' into nbgv

2cd7031

Rob-Hague force-pushed the nbgv branch from 91476bf to 9362bba Compare July 26, 2024 17:44

Revert unnecessary test changes; remove unnecessary tests

a0bf4b1

Rob-Hague marked this pull request as ready for review July 26, 2024 18:58

Rob-Hague approved these changes Jul 27, 2024

View reviewed changes

Rob-Hague merged commit 252c732 into sshnet:develop Jul 27, 2024
1 check passed

scott-xu deleted the nbgv branch August 5, 2024 15:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate with Nerdbank.GitVersioning #1299

Integrate with Nerdbank.GitVersioning #1299

scott-xu commented Jan 29, 2024

Rob-Hague commented Jan 31, 2024

Rob-Hague commented Jan 31, 2024

scott-xu commented Feb 16, 2024

Rob-Hague commented Feb 16, 2024

Rob-Hague left a comment

Rob-Hague Feb 24, 2024

scott-xu Feb 25, 2024

scott-xu commented Feb 25, 2024

WojciechNagorski commented Feb 25, 2024

scott-xu commented Feb 25, 2024

WojciechNagorski commented Feb 25, 2024

Rob-Hague commented Jul 26, 2024

Rob-Hague commented Jul 26, 2024

Rob-Hague commented Jul 27, 2024

Integrate with Nerdbank.GitVersioning #1299

Integrate with Nerdbank.GitVersioning #1299

Conversation

scott-xu commented Jan 29, 2024

Rob-Hague commented Jan 31, 2024

Rob-Hague commented Jan 31, 2024

scott-xu commented Feb 16, 2024

Rob-Hague commented Feb 16, 2024

Rob-Hague left a comment

Choose a reason for hiding this comment

Rob-Hague Feb 24, 2024

Choose a reason for hiding this comment

scott-xu Feb 25, 2024

Choose a reason for hiding this comment

scott-xu commented Feb 25, 2024

WojciechNagorski commented Feb 25, 2024

scott-xu commented Feb 25, 2024

WojciechNagorski commented Feb 25, 2024

Rob-Hague commented Jul 26, 2024

Rob-Hague commented Jul 26, 2024

Rob-Hague commented Jul 27, 2024