GitReleaseNotes icon indicating copy to clipboard operation
GitReleaseNotes copied to clipboard

update nuspec with release notes

Open JakeGinnivan opened this issue 11 years ago • 10 comments

So I can just hit publish

JakeGinnivan avatar Dec 13 '13 15:12 JakeGinnivan

I normally find myself creating the nuget at build time and having it as an artifact. When would you want to create it at publish time?

robdmoore avatar Dec 14 '13 01:12 robdmoore

This can be run at build time, you would just run again at publish time?

JakeGinnivan avatar Dec 15 '13 13:12 JakeGinnivan

If its a build artifact you don't need to? And if you have just compiled the binaries you would want to run it at build time rather than publish?

robdmoore avatar Dec 15 '13 13:12 robdmoore

I am not sure I understand the issue here. Why cannot we run it at build time and update the nuspec with release notes as @robdmoore said and later just publish the package? What am I missing?

MehdiK avatar Jan 14 '14 21:01 MehdiK

For me it is more the contents. The release notes I want a much shorter list?

JakeGinnivan avatar Jan 14 '14 21:01 JakeGinnivan

The other problem is the fidelity on nuget sucks. You have plan text only - no hyperlinks or markdown

robdmoore avatar Jan 14 '14 21:01 robdmoore

Thinking about this, in reality the issues will not be closed on GitHub until probably after the Pull Request is merged. Which means things would be missing from the NuSpec

It is probably easier just linking to releases and not worry about this?

JakeGinnivan avatar Jan 16 '14 14:01 JakeGinnivan

Would it be an idea to have different output formats? So you could output the release notes in Markdown, some text format for NuSpec files and maybe HTML or something? That way the user can generate the release notes when they want and use them how they want.

For my stuff at the moment I'm embedding the Markdown straight in the NuGet package file which is readable but rather ugly.

pvandervelde avatar May 15 '14 02:05 pvandervelde

I'm not sure how to do the NuSpec, it should really be headlines of the changes and not the full list (because that does not display well).

Personally, I am moving to the model I describe in this upcoming blog post - https://github.com/JakeGinnivan/jakeginnivan.github.io/blob/source/source/_posts/2014-05-13-simple-versioning-and-release-notes.md

Keen to know what you think.

JakeGinnivan avatar May 15 '14 05:05 JakeGinnivan

I've finally had some time to read the article. Your workflow is a bit different than mine but I don't see any strong benefits for either workflow. I'd prefer to regenerate the release notes and the nuspec files so hence why I was asking for the ability to generate the release notes in text or HTML formats.

pvandervelde avatar May 19 '14 10:05 pvandervelde