-
Notifications
You must be signed in to change notification settings - Fork 891
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
Enhance the nuspec - first wave #205
Comments
The second wave is #325. |
Extend Nuspec metadata to include: - Project source url - Package source url - Docs url - Wiki Url - Mailing List Url - Bug Tracker Url Adding the following elements, reserving for future use with respect to package relationships. - Replaces - Provides - Conflicts
Vendoring NuGet.Core allows us to take advantage of our own fixes to the provider. There are things that have been wanted for awhile that don't have a workaround to change the setting. - GH-290 - packages no longer have a restriction on content folders that produces the "External packages cannot depend on packages that target projects". I'd like to call it a bug, and for Chocolatey it certainly is. - GH-194 - Fix minimum NuGet client version reports Chocolatey version instead of NuGet's version, which is fine for packages on Chocolatey, but the ones on NuGet usually have this filled in, which makes them impossible to install with choco. - GH-205 - Enhance the nuspec - first wave. Add the most oftenly requested url for the nuspec, the packageSourceUrl and several other urls plus add in replaces, provides and conflicts as placeholders for now.
Add the following fields to the nuspec that is generated: -packageSourceUrl -projectSourceUrl -docsUrl -wikiUrl -mailingListUrl - bugTrackerUrl
It's really the same thing as documentation link, so there is no reason to carry an extra unnecessary field in the nuspec.
* stable: (GH-205) remove the wiki url
In the directives surrounding the nuspec template, give the user better hints about how to set things up.
* stable: (GH-331) Transformation Specs (GH-331) replace config w/backup if XDT (GH-331) Use XDT transforms on configs (maint) comment grammar (spec) add ExpectedExceptionAttribute override (GH-331) update config/transform for v1.1.0 (GH-331) add transform and config to upgrade pkg (GH-205) Enhance nuspec template instructions Conflicts: src/chocolatey/chocolatey.csproj
:) ... I see what you did there. |
forumUrl ? |
mailinglisturl would be sufficient to use the same as you need for forumUrl? |
Shouldn't MailingListUrl contains something like "mailto:software-list@example.com?subject=subscribe"? |
I assumed that mailingListUrl would point to a web page for accessing archives and subscribing. |
Then we need something like MailingListSubscribeUrl and MailingListUnsubscribeUrl? |
@pyhedgehog you are leaning towards what would be overkill, yep. The idea behind mailingListUrl if folks wanted to use it is what @RichiCoder1 mentioned. |
@ferventcoder in spirit I agree in practice, let's see...
Just mulling over it, mailingListUrl and forumUrl are two different methods of the same overarching theme; engagment of the community with each other. It's just the mechanism of which that happens uses different technology; email and BBS in this case. From my inventory, "forum" is more popular in practice. And drawing on history, probably more familiar with users because the idea already permeated the world with the Roman empire. A forum is just a public place to gather and engage. Mailing list to me has a more specific purpose. Also, just fyi, there's IRC to round out the old-school technologies...
... but would probably better be labeled as chatUrl to keep up with newer services like Gitter.im would fall under. So by just my packages, only 17 would be affected by only having one discussionUrl. But my vote would be forumUrl for user familiarity and it is more congruent by actual conditions. Also, I will chime in my reason for including more metadata in my packages. Chocolatey lets you automate installs, but also removes needing to hunt and peck for clicky things. I figure, why not extend this to the websites themselves by just grabbing some of the links while I'm scraping? There are more uses than just having a convenient hyperlink when you need it. By being a full-fledged package manager with standardized XML data, you could imagine doing a search for all packages you have installed with chatUrl so you can quickly get a list to add to your multi-protocol chat client. Of course the URLs can change and need to be updated, but I don't think that's too common. Also, it lets you count what technology software developers are using so you can make the right decision when it comes to choosing if mailingListUrl is the right choice ;) Eventually the metadata becomes overwhelming and that becomes a presentation thing or the metadata becomes sentient and grows into actionable events like @pyhedgehog noted. |
I should also mention that I didn't start collecting this metadata into the nuspec from the beginning. I must have been at least through several hundred packages before I realized what I was doing and it may be useful to grab. It dawned on me when I found I was having difficulty more often than I liked finding a program's forum. So 131 only indicates the minimum amount of packages with forums. Here's what I've been grabbing:
When software is client for a web service The next are all very related, and sometimes predictable, but also sometimes not. I try not to spend too much time, but sometimes a changelog isn't in the repo for whatever reason, or is formatted poorly and the web version gets rendered more readable.
I try to not be overwhelming, but different people can see different uses for stuff. And I'm not sure why people dislike too many tags in XML. Just because it is in the chocospec doesn't mean it has to be rendered by your package manager, or in most cases, the web gallery. |
I can imagine not surfacing most of these to end users of ChocoGUI except for as an advanced option. |
@ferventcoder Should projectSourceUrl point to a website hosting the source (e.g. a GitHub page) or the actual |
Website hopefully, but if that is not available, a secondary tar for download is possibly okay. |
The original intent is a url to a website. |
Allow the following extra metadata into the nuspec:
This is chocolatey-archive/chocolatey#172 and is related to https://github.com/chocolatey/chocolatey.org/issues/101
The text was updated successfully, but these errors were encountered: