Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/buehler/semantic-release-net
Semantic release plugin for dotnet (nuget) projects
https://github.com/buehler/semantic-release-net
Last synced: 29 days ago
JSON representation
Semantic release plugin for dotnet (nuget) projects
- Host: GitHub
- URL: https://github.com/buehler/semantic-release-net
- Owner: buehler
- License: apache-2.0
- Created: 2023-01-19T15:46:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T04:15:45.000Z (about 1 month ago)
- Last Synced: 2024-10-10T12:52:11.836Z (about 1 month ago)
- Language: TypeScript
- Size: 613 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# semantic release net
Semantic release plugin to publish .NET packages to NuGet sources.
Performs the following actions:
- verifyConditions: Checks if the default nuget token (`NUGET_TOKEN`) is set,
or if sources are set, if the corresponding tokens are set.
- prepare: Creates the NuGet packages using `dotnet pack` with the corresponding new
version and release notes.
- publish: Publishes the NuGet packages to the configured NuGet sources.
Packages are created in their corresponding `bin/$(Configuration)/` folder.
To enable / disable package creation, you can set the `true`
option in the `.csproj` file.
## Configuration
If _no_ sources are configured, the `NUGET_TOKEN` env var must be set.
The default nuget source (`https://api.nuget.org/v3/index.json`) is used in this case.
### Options
- `configuration`: The configuration to use for `dotnet pack` (default: `Release`)
- `pack`: Whether the plugin should run `dotnet pack` (default: `true`)
- `additionalPackArgs`: Array of strings to pass as additional arguments to `dotnet pack`
- `additionalPublishArgs`: Array of strings to pass as additional arguments to `dotnet nuget push`
- `sources`: Array of sources to publish to. Each source must have the following properties:
- `url`: The url of the source
- `apiKeyEnvVar`: The name of the environment variable that contains the API key for the source
```typescript
// Type definition of the plugin options
export type PluginConfig = {
configuration?: 'Release' | 'Development';
pack?: boolean;
additionalPackArgs?: string[];
sources?: { url: string; apiKeyEnvVar: string }[];
additionalPublishArgs?: string[];
};
```
#### Configuration example when using default nuget
```jsonc
// .releaserc.json example
{
"plugins": [
[
"semantic-release-dotnet",
{
"configuration": "Release",
"pack": true,
"additionalPackArgs": ["/property:PackageIcon=icon.png"],
"additionalPublishArgs": ["--skip-duplicates"]
}
]
]
}
```
#### Configuration example when specifying sources
```jsonc
// .releaserc.json example
{
"plugins": [
[
"semantic-release-dotnet",
{
// key/value config of the other example...
"sources": [
{
"url": "https://api.nuget.org/v3/index.json",
"apiKeyEnvVar": "NUGET_TOKEN"
},
{
"url": "https://nuget.pkg.github.com/buehler/index.json",
"apiKeyEnvVar": "GH_NUGET_TOKEN"
}
]
}
]
]
}
```