创建并发布一个 .NET 的 NuGet 包并不复杂,只要掌握基本流程和关键配置。下面是一个清晰、实用的步骤指南,帮助你从零开始打包并发布到 nuget.org。
1. 准备项目并启用包生成
要创建 NuGet 包,首先需要一个类库项目(Class Library)。确保项目格式为 SDK 风格(推荐使用 .NET Standard 或 .NET Core/.NET 5+)。
在项目文件(.csproj)中添加必要的元数据,这些信息会显示在 NuGet 包页面上:
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<PackageId>MyCompany.MyLibrary</PackageId>
<Version>1.0.0</Version>
<Authors>Your Name</Authors>
<Company>MyCompany</Company>
<Description>A short description of your library.</Description>
<PackageTags>example;utility</PackageTags>
<PackageProjectUrl>https://github.com/yourname/MyLibrary</PackageProjectUrl>
<RepositoryUrl>https://github.com/yourname/MyLibrary</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<Copyright>© MyCompany. All rights reserved.</Copyright>
<PackageReleaseNotes>Initial release.</PackageReleaseNotes>
<strong><GeneratePackageOnBuild>true</GeneratePackageOnBuild></strong>
</PropertyGroup>
</Project>
说明:
GeneratePackageOnBuild:设置为 true 后,每次构建都会生成 .nupkg 文件,方便测试。 TargetFramework:根据兼容性选择 netstandard2.0、net6.0 等。 PackageId:必须在 nuget.org 唯一。2. 构建项目生成 .nupkg 包
保存项目文件后,在命令行运行:
dotnet build
构建成功后,在 bin/Debug 或 bin/Release 目录下会生成 .nupkg 文件。这是你的 NuGet 包。
你可以用 NuGet Package Explorer 打开它,检查内容和元数据是否正确。
3. 注册 nuget.org 账号并获取 API Key
前往 https://www.nuget.org 注册账号(如果还没有)。
登录后,进入“API Keys”页面创建一个新的密钥:
选择“Create a new API key” Description 填写用途,如“My First Package” Scope 选择“Push new packages” Include package named: 填写你的 PackageId(支持通配符) 点击“Create”生成密钥复制生成的 API Key(只显示一次,务必保存好)。
4. 使用命令行发布包
在项目目录下运行以下命令推送包:
dotnet nuget push "bin/Debug/MyCompany.MyLibrary.1.0.0.nupkg" --api-key YOUR_API_KEY --source https://api.nuget.org/v3/index.json
如果一切正常,你会看到“Your package was pushed.”的提示。
稍等几分钟后,就可以在 nuget.org 搜索到你的包了。
5. 更新和重新发布
修改代码后,只需更新项目文件中的 Version 字段(如改为 1.0.1),然后重新构建并推送即可。
注意:nuget.org 不允许覆盖已发布的版本,必须使用新版本号。
基本上就这些。只要配置好项目元数据,生成包和发布都很简单。关键是确保包名唯一、版本递增、API Key 安全保管。
