Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support URLs as entire "release notes" contents #4023

Closed
mgravell opened this issue May 27, 2017 · 7 comments
Closed

Support URLs as entire "release notes" contents #4023

mgravell opened this issue May 27, 2017 · 7 comments

Comments

@mgravell
Copy link

mgravell commented May 27, 2017

Release notes are a bit awkward in the app, and updating them in the package is usually a bad idea as it is hard (impossible) to fix the release notes. Additionally, in the csproj or nuspec is a horrible place to try to store cumulative notes. And the formatting is poor.

As such, a lot of people just use a URL. There exists #2280 to improve the formatting (which would allow this indirectly, by using [see here](https://some.com/url) as the notes), but as a really quick win that doesn't get bogged down in lots of questions like "which variant of markdown?", pragmatic option:

If the release notes are a http[s] URL and just a http[s] URL: linkify it in the gallery.

I would be happy to submit a PR if it helps (thought it best to discuss first).

@mgravell mgravell changed the title Support URLs in release notes Support URLs as entire "release notes" contents May 27, 2017
@Drawaes
Copy link

Drawaes commented May 28, 2017

I use a csproj include based on the version number I tag it in during the build...
https://github.com/Drawaes/CondenserDotNet/tree/master/releasenotes
Granted I don't have a lot in them at the moment but I could.

If you look at my appveyor build it checks if there was a release tag that triggered the build and if so changes the include.

@NickCraver
Copy link
Contributor

Related: see NuGet/Home#1734 which was merged into NuGet/Home#1203

I think making it recognize and auto-link URLs seems like a very cheap Gallery-only win though. Perfection shouldn't be the blocker to incremental, easy, substantial improvements here.

@Drawaes
Copy link

Drawaes commented May 29, 2017

I tend to agree, what is the goal here though? To scrap the data from the URL and pull it into nuget? If so that leads to a load of potential problems. Why not make it MD ?

@NickCraver
Copy link
Contributor

Nope - literally to make it clickable, that's it. I think it should be makrdown, etc., but a very easy win would be to just make it a link.

@Drawaes
Copy link

Drawaes commented May 29, 2017

In that case, I withdraw my comments and it give it a thumbs up

@skofman1
Copy link
Contributor

Thanks for the feedback @mgravell , @NickCraver , @Drawaes . We are currently working on improvments in this area and will take your feedback into account.

//cc @chenriksson , @jonwchu

@skofman1
Copy link
Contributor

@mgravell , our preview site includes the change you requested:
#4492
#4505

Feel free to reopen this issue if the added feature doesn't cover your ask.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants