Link to Release notes from Nuget package?

SeanKilleen commented 8 months ago

We're using RennovateBot to pull in dependency updates (I imagine this is similar for anyone using Dependabot).

I see a new release of Phobos is available, but since I'm a responsible developer, I try to look at what's in a release before merging it (even though I have a higher trust in your Semver commitment than with many other projects).

My current process is something like:

Ooh! An update!
Hmm, no release notes noted surface by the bot. That's fine, I'll find them.]
Hmmm...where are those stored again?
Let me check the Nuget package. Nothing in release notes for the package itself.
OK, there's a link in the Nuget package
OK, maybe it's in docs
Hmm, where's release notes? (looking for it at the top and inevitably missing "Version Notes" as a topic)
Finally finding Version notes -> Release notes.

Now, I'm not blameless in this by any means 😅 But it would be great to get a link to the release notes, perhaps as part of the Nuget package metadata itself upon publish. Even a static link to the release notes general page would be helpful.

Aaronontheweb commented 8 months ago

Hi Sean,

We do embed the full release notes into the NuGet package metadata itself, but I wonder if that's not being surfaced properly in Sdkbin 1.0's NuGet feed. They do appear on the Sdkbin gallery automatically though: https://sdkbin.com/publisher/petabridge/product/phobos/packages/phobos.actor/versions/2.5.0

I don't think we'll fix this in Sdkbin 1.0's NuGet mechanism, but I do know for certain it's already fixed in Sdkbin 2.0.

100% agree that we should do this though.

Aaronontheweb commented 8 months ago

But one thing I can also start doing is linking to https://phobos.petabridge.com/articles/releases/RELEASE_NOTES.html in each of the subsequent releases - that's where the notes usually go in pretty markdown format (Sdkbin 2.0's gallery will also do this.)

SeanKilleen commented 8 months ago

Interesting -- in all my attempts I didn't wind up at the SDKbin link. Maybe just a muscle memory thing?

Both proposed steps sound good to me!

petabridge / phobos-issues

Link to Release notes from Nuget package? #76