Yak currently broken?

Rhino Developer Yak
, ,
1

Hi there,

I’ve recently tried using Yak to package up a plugin, but have run into some very odd behaviour. There are two odd/broken behaviours.

The first behaviour doesn’t seems to have anything to do with the plugin itself, but rather the length of the path to the plugin’s assemblies–it even exists when packaging up the Visual Studio “RhinoCommon Plug-In for Rhino3D(C#)” project if its path is long enough. For the rest of the post, I’ll only be using that template project. So if you wish to reproduce, just use this:

image
image802×634 20.6 KB

I’ll illustrate it with the following screenshot:

image
image1360×698 41.1 KB

The projects in both directories are exactly the same, but one has a longer path than the other. The project with the longer path has all the has this behaviour: the version detected by yak is the assembly version (1.0) but then appended with a long (non-sense?) string of numbers and letters.

The second behaviour happens regardless of the path to the plugin’s assemblies: The data that was specified in the manifest.yml file isn’t populated. And the version selection dropdown is broken. Even when multiple version are installed, the dropdown is still empty.

image
image1202×610 26.8 KB

Proof that the manifest contains the authors and the description:

---
name: MyRhinoPluginShortPath
version: 1.0.0
authors:
- MyRhinoPluginShortPath Authors
description: Description of MyRhinoPluginShortPath
url: <url>

To shed some more light on the missing information, the registry doesn’t contain it either:

image
image1358×385 10.7 KB

This means when the .yak package was installed, the manifest info wasn’t propagated to the registry.

This is my currently installed Rhino version:
image

Kind regards,
Dustin

1 Like
2

I’ve been having this issue too - any solutions?

3

I’ve also been seeing this

4

Thanks for reporting this @Dustin_Condon ,

I can repeat this behaviour, although my version drop down works correctly. What route did you take to add MyRhinoPluginShortPath to Yak?

Ticket for the first issue:
RH-85041 Yak adds + 40 strings to version…

5

Thanks for the detailed steps! I was able to reproduce the behaviour that you’re seeing and found something curious. The extra build metadata is added to the version number (after the “+”) by the .NET build process. I did some digging and found that this is actually the git commit SHA, since the second (long path) project is inside the cloned rhino-developer-samples git repo.

You can disable this by adding <IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion> to your csproj file.

For example:

...

  <PropertyGroup>
    <!-- Specifies information for Assembly and Yak -->
    <Version>1.0</Version>
    <IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
    <Title>MyRhinoPlugin</Title>
    <Company>MyRhinoPlugin Authors</Company>
    <Description>Description of MyRhinoPlugin</Description>
  </PropertyGroup>

...
6

Thank you for looking into this! Sorry for the late reply. So all I did to generate the .yak package was:

  1. build the MyRhinoPluginShortPath project in Release|AnyCPU,
  2. go to bin/Release/net7.0, call yak.exe spec (I’ve added Rhino’s System directory to my path just to make calling yak easier).
  3. then call yak.exe build
  4. Drag the generated yak file into an open instance of Rhino

Steps #2, and #3 are displayed here via screenshot of the cmd window:

image
image997×888 24.8 KB

And after doing this and checking on the package using the “PackageManager” command, I cannot see any of the data from the manifest file, other than the version:

image
image1190×358 18.9 KB

Let me know if there any other things I can do to help narrow it down.

Kind regards,
Dustin

7

Thank you very much for figuring that out! It does fix the warning I’ve encountered with using “yak.exe build”. It also makes using the $version entry in the manifest usable (otherwise the version reported in Rhino would include SHA string).

However, it doesn’t seem to affect the other issues I’m experiencing with the manifest info not getting populated in Rhino though and the version dropdown not working in the PackageManager window.

Again, let me know if there’s something I can do to help narrow it down.

Kind regards,
Dustin