Skip to content

Chocolatey

Publish to Chocolatey for Windows package management.

Configuration

yaml
publishers:
  - type: chocolatey
    package: myapp

Options

OptionDescriptionDefault
packagePackage IDProject name
titleDisplay titlePackage ID
descriptionPackage descriptionFrom project
authorsPackage authorsFrom git config
licenseLicense URLAuto-detected
projectUrlProject homepageRepository URL
iconUrlPackage icon URLNone
tagsPackage tags[]

Examples

Basic Package

yaml
publishers:
  - type: chocolatey
    package: core

With Metadata

yaml
publishers:
  - type: chocolatey
    package: core
    title: "Core CLI"
    description: "CLI for building and deploying applications"
    tags:
      - cli
      - devops
      - build
    iconUrl: https://example.com/icon.png

Environment Variables

VariableDescription
CHOCOLATEY_API_KEYChocolatey API key (required)

Setup

  1. Create a Chocolatey account at https://community.chocolatey.org

  2. Get your API key from your account settings

  3. After publishing, users install with:

    powershell
    choco install myapp

Generated nuspec

xml
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
  <metadata>
    <id>myapp</id>
    <version>1.2.3</version>
    <title>Core CLI</title>
    <authors>Host UK</authors>
    <description>CLI for building and deploying applications</description>
    <projectUrl>https://github.com/org/myapp</projectUrl>
    <licenseUrl>https://github.com/org/myapp/blob/main/LICENSE</licenseUrl>
    <tags>cli devops build</tags>
  </metadata>
  <files>
    <file src="tools\**" target="tools" />
  </files>
</package>

Released under the EUPL-1.2 License.