@zedtk/semantic-release-nuget
semantic-release plugin to publish a NuGet package.
| Step | Description |
|---|---|
verifyConditions |
Verify the configuration. |
prepare |
Update the .csproj version and create the NuGet package. |
publish |
Publish the NuGet package to the registry. |
Install
$ npm install @zedtk/semantic-release-nuget -DUsage
The plugin can be configured in the semantic-release configuration file:
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@zedtk/semantic-release-nuget"
]
}Configuration
Environment variables
| Variable | Description |
|---|---|
NUGET_API_KEY |
API key for the NuGet registry |
Options
| Options | Description | Default |
|---|---|---|
publish |
Whether to publish the NuGet package to the registry. |
true |
projectRoot |
Directory path to publish. | . |
buildConfiguration |
Project build configuration. | Release |
includeSymbols |
Whether to publish a symbols package (.snupkg). |
true |
packageDir |
Directory path in which to write the the package. | dist |
registry |
Registry name (existing NuGet source), url or path to which push the package. | https://api.nuget.org/v3/index.json |
Note: If publish is false the .csproj version will still be updated.
Note: The projectRoot directory must contain a .csproj. The version will be updated only in the .csproj within the projectRoot directory.
Note: The includeSymbols option allows Source Link support. Some resources to help configure your project:
- Producing Packages with Source Link
- Using Source Link in .NET projects and how to configure Visual Studio to use it
Note: If you use a shareable configuration that defines one of these options you can set it to false in your semantic-release configuration in order to use the default value.
Examples
The publish and packageDir option can be used to skip the publishing to the NuGet registry and instead, release the package tarball with another plugin. For example with the @semantic-release/github plugin:
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
[
"@zedtk/semantic-release-nuget",
{
"publish": false,
"packageDir": "dist"
}
],
[
"@semantic-release/github",
{
"assets": "dist/*.nupkg"
}
]
]
}