@vmvarela/semantic-release-chocolatey

Package binaries into Chocolatey .nupkg packages during semantic-release.

Usage

plugins:
  - '@vmvarela/semantic-release-chocolatey':
      nuspec_template: "packaging/chocolatey/template.nuspec"
      install_template: "packaging/chocolatey/chocolateyInstall.ps1"
      assets:
        - "my-cli-x86_64-windows.exe"
        - "my-cli-aarch64-windows.exe"

Config

| Option | Type | Required | Description | |--------|------|----------|-------------| | nuspec_template | string | yes | Path to Handlebars .nuspec template | | install_template | string | yes | Path to Handlebars chocolateyInstall.ps1 template | | assets | string[] | yes | Binary filenames (relative to dist/) to include in tools/ |

Template variables

Both templates receive these Handlebars variables:

• {{version}} — release version (e.g. 1.2.3)
• {{name}} — package name (derived from repo basename, semantic-release- prefix stripped)
• {{assets}} — array of asset filenames from config

Example .nuspec template:

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
  <metadata>
    <id>{{name}}</id>
    <version>{{version}}</version>
    <title>{{name}}</title>
    <description>My CLI tool</description>
  </metadata>
</package>

Example chocolateyInstall.ps1 template:

$ErrorActionPreference = 'Stop'
$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$packageName = '{{name}}'

Install-ChocolateyZipPackage `
  -PackageName "$packageName" `
  -Url "https://github.com/vmvarela/{{name}}/releases/download/v{{version}}/{{lookup assets 0}}" `
  -UnzipLocation "$toolsDir"

Publish (push to Chocolatey Community Repository)

By default the plugin only creates the .nupkg during the prepare step. To automatically push it to the Chocolatey Community Repository, set the CHOCOLATEY_API_KEY environment variable:

export CHOCOLATEY_API_KEY="your-api-key"

When CHOCOLATEY_API_KEY is present, the publish step runs:

choco push dist/{name}.{version}.nupkg --source https://push.chocolatey.org/ --api-key {key}

When the env var is absent, publish logs a skip message and returns — safe to use with a single semantic-release config across repos that may or may not need publishing.

Requirements

• zip command available on $PATH
• semantic-release ^24
• Node >= 24