I'm developing a NuGet package and keep it open source at github.com
My package after installation requires a few configuration steps to be done in VS solution, and I document this in README.md file on github.
I'd like to reference this README.md file in the NuGet package, so that people know what to do after package installation.
I've specified <projectUrl> in my .nuspec file pointing to my Git repo on github.
But it's not obvious for users that they need to click it to read documentation.
I'd like to make it loud and clear for users to follow the link to read full documentation.
It would be nice to have a hyperlink, for example in the <description> field of the .nuspec file, so it's displayed as a hyperlink on the:
project page on nuget.org
package details shown in Visual Studio when browsing \ installing the package
I've tried different ways to add a link, for example XML-escaping < and > as < and > but it doesn't show it as a link, but just as an html text.
The < licenseUrl> and < projectUrl> are the two tags which will show hyperlink in the NuGet package manager. You cannot provide hyperlinks in any other tags. If you want to provide a hyperlink use any of these. Otherwise, you can use a readme file.
Related
I have published a NuGet package with a README.md file in it. The README is displayed normally but without images.
How NuGet.org shows pictures
In F12 it looks like that:
F12 Description
I am aware that NuGet.org only allows images from trusted sources. Therefore the images are stored on a public GitHub repository.
I can see the images when editing them in VS code.
Image Link in VS Code
Also it is not an error while packing the nuspec.
Thanks for your help.
-Simon
I built a docker image and published it to github package registry under an organization and linked it to a specific repository. However, I would like to specify a different README file to be displayed in the package registry under the image I published.
Currently, the README that is displayed is the general one for my repository. Is there a way to change/specify which one is displayed for my package?
No, that's currently not possible. When a repository is linked to the package, it will show the repository's readme. When you navigate to a specific version of the package, it will show that version's readme.
This pylance GH link renders the new-issue page as
whereas my own new-issue page is rendered as
which, I guess, is using some kind of blank-issues
per GH doc, I need to add a config.yml file to the .github/ISSUE_TEMPLATE folder.
However, there isn's a config.yml file in pylance GH .github/ISSUE_TEMPLATE folder.
Is the config.yml file what I need for the new-issue page pointed out by the red arrow? or I misunderstood the GH doc?
The config.yml is used to generate links outside of Github. For example to invite users to use stackoverflow to ask question instead of the github issues.
To add template choices (as you have in the red square), you will have to add template files in the form of .md files in the .github/ISSUE_TEMPLATE folder. You can see example of those template files in the pylance GH .github/ISSUE_TEMPLATE folder
It my GitHub Pages page for my project, the only download options are for the .zip and the .tar.gz files (the standard ones including "See this on GitHub"). I want to have a link to download another file (a .exe file) without having to put it in my GitHub repository. How can I do this?
I'm not sure how GitHub Pages relates here (this likely depends on the theme you're using), but one good option for sharing pre-built versions of your software is to create a GitHub Release. This will prompt you to create a tag for the version of your source code you wish to release and let you upload additional files:
Optionally, to include binary files such as compiled programs in your release, drag and drop or select files manually in the binaries box.
This file won't be added to your Git repository. It's attached to the GitHub-specific Release, and it can then be downloaded from your repository's releases tab, just like source archives.
I created a nuget package (let's name it Web.Content) with lots of js, css and other content for my other package (named Web). In nuspec file I had file section
<file src="Content\**\*.*" target="content\Content" />
I made changes in some files from Content folder, then I created a new version of Web.Content package.
I have a project that includes Web and Web.Content packages. After a new version of Web.Content package was created I updated it in my project via nuget. When I try to commit changes of my project, SVN suggests me to commit all content of Web.Comment package.
As I understand, when nuget package was updated all target folder "content\Content" was deleted and copied from package again.
But I need SVN to trace only changes that were made in a couple of files, I don't want to see thousands of changed files because actually changes were made only in some of them.
How can I make nuget copy only changed files? Should I change my nuspec file or should I create some PS script for my package that will override delete'n'copy nuget package update behaviour?
It will be great to have some examples or links.
Tried with NuGet 2.6.40627.9000 and Tortoise SVN 1.7.7.
As far as I understand NuGet copies files during package installation using somу VS API. This API makes SVN think that the file was deleted and a new file was added(probably this happened because VisualSVN or AnkhSVN is installed).
So we decided to do the next steps:
Place our content items in our own folder which name differs from
"Content"(let's name it "fs_content") because the presence of such
folder in package triggers NuGet usual installation behavior, but
we don't need NuGet to install our content in usual way.
Write own install.ps1 script that copies our content files to
destination and put it into Tools package folder.
But after installing such package our content items did not appear where they should appear. My colleague googled some information in NuGet help - "The package must have files in the content or lib folder for Install.ps1 to run. Just having something in the tools folder will not kick this off." We placed a dummy file into "Content" folder and Install.ps1 script began to copy our content from "fs_content" folder as we want.
Now SVN determines only changes made in some files correctly.