| title | description | author | ms.author | ms.date | ms.topic | ms.reviewer |
|---|---|---|---|---|---|---|
How to publish NuGet packages |
See detailed instructions about how to publish a NuGet package and manage package ownership on nuget.org. |
JonDouglas |
jodou |
8/29/2022 |
conceptual |
anangaur |
Once you create a NuGet package and have a .nupkg file, you can make the package available to other developers either publicly or privately. This article describes how to share public packages globally through nuget.org.
You can also make private packages available to only a team or organization by hosting them on a file share, a private NuGet server, or a third-party repository such as myget, ProGet, Nexus Repository, or Artifactory. For more information, see Host your own NuGet feeds. For publishing with Azure Artifacts, see Publish packages to NuGet.org.
To publish on nuget.org, sign in to nuget.org with a Microsoft account, and use it to create a free nuget.org account. Follow the instructions at Add a new individual account.
Once you have an account, you can publish a package to nuget.org by using the nuget.org web portal, the dotnet CLI, or the NuGet CLI version 4.1.0 or above. You can also publish packages through Azure Pipelines.
To upload a package to the nuget.org website:
-
Select Upload on the top menu at nuget.org, browse to the package on your computer, and select Open.
If the package ID already exists on nuget.org, you get an error. Change the package identifier in your project, repack, and try the upload again.
-
If the package name is available, the Verify section opens so you can review the metadata from the package manifest. If you included a readme file in your package, select Preview to make sure all content renders properly.
To change any of the metadata, edit your project file or .nuspec file, rebuild, repack, and upload again.
-
When all the information is ready, select Submit.
To push packages to nuget.org with a command line, you can use either dotnet.exe or nuget.exe v4.1.0 or above, which implement the required NuGet protocols. For more information, see NuGet protocols.
To use either command line, you first need to get an API key from nuget.org.
[!INCLUDE publish-api-key]
[!INCLUDE publish-dotnet]
-
At a command prompt, run the following command, replacing
<your_API_key>with the key you got from nuget.org:nuget setApiKey <your_API_key>This command stores your API key in your NuGet configuration so you don't need to enter the API key again on the same computer.
[!NOTE] This API key isn't used to authenticate with private feeds. To manage credentials for authenticating with these sources, see the nuget sources command.
-
Push the package by using the following command:
nuget push YourPackage.nupkg -Source https://api.nuget.org/v3/index.json
You can push packages to nuget.org with Azure Pipelines as part of your continuous integration/continuous deployment (CI/CD) process. For more information, see Publish NuGet packages with Azure Pipelines.
To submit a signed package, you must first register the certificate you used to sign the package. If you don't meet the signed package requirements, nuget.org rejects the package.
Nuget.org has a package size limit of about 250 MB. When a package exceeding that limit is uploaded the following error is displayed:
The package file exceeds the size limit. Please try again.
If such package is pushed from the command line, the following output is produced:
RequestEntityTooLarge https://www.nuget.org/api/v2/package/ 13903ms
error: Response status code does not indicate success: 413 (The package file exceeds the size limit. Please try again.).
If you are getting this errors consider revising the package content to reduce its size. If you are packing debug symbols into your package consider publishing them separately. Other assets can be published separately as one or more dependency packages to spread them into smaller chunks.
Packages pushed to nuget.org undergo several validations, such as virus checks, and existing packages are periodically scanned. When the package passes all validation checks, it might take awhile to be indexed and appear in search results. While the package is being indexed, it appears under Unlisted Packages, and you see the following message on the package page:
Once validation and indexing are complete, you receive an email that the package was successfully published. If the package fails a validation check, the package page updates to display the associated error, and you receive a notification email.
Package validation and indexing usually take less than 15 minutes. If package publishing is taking longer than expected, check nuget.org status at status.nuget.org. If all systems are operational and the package isn't successfully published within an hour, contact nuget.org by using the Contact support link on the package page.
To see package status, select Manage packages under your account name at upper right on nuget.org, and select the package from Published Packages or Unlisted Packages.
Package owners have full permissions for the package, including adding and removing other owners and publishing updates.
Although the NuGet package's .nuspec file defines the package's authors, nuget.org doesn't use that metadata to define ownership. Instead, nuget.org assigns ownership to the person who publishes the package, either the signed-in user who uploaded the package, or the user whose API key was used with dotnet push, nuget SetApiKey, or nuget push.
To change ownership of a package:
-
Sign in to nuget.org with the account that currently owns the package.
-
Select your account name at upper right, select Manage packages, and expand Published Packages.
-
Select the package you want to manage, and on the right side of the package page, select Manage package.
-
On the package management page, select Owners.
-
Take one of the following actions:
-
Select Remove to remove the current owner.
-
Add an owner under Add owner by entering their user name and a message, and selecting Add.
This action sends an email to the new co-owner with a confirmation link. Once confirmed, that person has full permissions to add and remove owners. Until confirmed, the Current owners section shows pending approval for that person.
-
To transfer ownership, as when ownership changes or a package publishes under the wrong account, add the new owner. Once they confirm ownership, they can remove the old owner from the list.
To assign ownership to a company or group, create a nuget.org account with an email alias that forwards to the appropriate team members. For example, various Microsoft ASP.NET packages are co-owned by the microsoft and aspnet accounts.
Occasionally, a package might not have an active owner. For example, the original owner might have left the company that produced the package. If you're the rightful owner of a package and need to regain ownership, use the contact form on nuget.org to explain your situation to the NuGet team. The team follows a process to verify your ownership, including trying to locate the existing owner, and can send you a new invitation to become the package owner.