Chocolatey

Publishes packages to https://chocolatey.org.

The following artifact extensions are supported by this packager:

.zip
.exe
.msi

Distribution Support

Distribution	Supported
Binary
Flat Binary
Java Binary
Jlink
Native Image
Native Package
Single JAR

Distribution

Supported

Local publication of packages requires running on Windows, have powershell and choco installed. If you rather package and push on CI then set remoteBuild to true.

Publication of snapshots is not allowed.

Configuration

Legend:

required
optional
may use environment variable
accepts Name Templates

YAML
TOML
JSON
Maven
Gradle

# 
packagers:
  # 
  chocolatey:
    # Enables or disables Chocolatey.
    # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
    # Defaults to `NEVER`.
    #  
    active: ALWAYS

    # Let the release continue if the packager fails.
    # Defaults to `false`.
    # 
    continueOnError: true

    # Custom download URL.
    #  
    downloadUrl: https://my.server.com/{{projectName}}/{{tagName}}/{{artifactFile}}

    # Additional properties used when evaluating templates.
    #  
    extraProperties:
      # Key will be capitalized and prefixed with `chocolatey`, i.e, `chocolateyFoo`.
      foo: bar

    # Directory with file templates used to prepare the Chocolatey distribution.
    # Defaults to `src/jreleaser/distributions/#{distribution.name}/chocolatey`.
    # If specified, path must exist.
    # 
    templateDirectory: path/to/chocolatey/templates

    # List of template files to be skipped.
    # Value may be an exact match or a regex.
    # 
    skipTemplates:
      - README.md.tpl

    # Git author used to commit to the repository.
    # 
    commitAuthor:
      # Name used when authoring commits.
      # Defaults to `jreleaserbot`.
      # 
      name: jreleaserbot

      # E-mail used when authoring commits.
      # Defaults to `jreleaser@kordamp.org`.
      # 
      email: jreleaser@kordamp.org

    # Git repository to push the manifest to.
    # Defaults are shown.
    # 
    bucket:
      # Enables or disables the bucket.
      # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      # Defaults to `RELEASE`.
      # 
      active: ALWAYS


      # The owner of the bucket.
      # Defaults to the same owner as the release repository.
      # 
      owner: duke

      # The name of the bucket.
      # Defaults to `chocolatey-bucket`.
      # 
      name: chocolatey-bucket

      # The tag associated with the manifest.
      # If left unspecified, will use `{{tagName}}`.
      #  
      tagName: '{{distributionName}}-{{tagName}}'

      # The target branch to pull from.
      # Defaults to the branch pointed by HEAD.
      #  
      branch: HEAD

      # The target branch to push to.
      # Defaults to the branch pointed by `#{branch}`.
      #   
      branchPush: '{{projectName}}-{{tagName}}'

      # Username used for authoring commits.
      # Must have write access to the bucket.
      # Defaults to the same username as the release repository.
      #  
      username: duke

      # Password or OAuth token with write access to the bucket.
      #  
      token: __USE_ENVIRONMENT_VARIABLE__

      # Message when committing to the bucket.
      # If left unspecified, `{{distributionName}} {{tagName}}` will be used.
      #  
      commitMessage: '{{distributionName}} {{tagName}}'

    # Name of the Chocolatey package.
    # Defaults to `#{distribution.name}`.
    # 
    packageName: app

    # Package version.
    # Defaults to `{{projectVersion}}`.
    #  
    packageVersion: 1.2.3

    # The username that can publish Chocolatey packages.
    # If left unspecified, the release owner will be used.
    # 
    username: duke

    # The ApiKey associated with the given account.
    #  
    apiKey: __USE_ENVIRONMENT_VARIABLE__

    # The source to push the package to.
    # If left unspecified, will use `https://push.chocolatey.org/`.
    # 
    source: https://push.chocolatey.org/

    # Whether to build the package on a remote server or locally.
    # Defaults to `false`.
    # 
    remoteBuild: false

    # The title of the spec.
    # If left unspecified, will use `#{project.name}`.
    # 
    title: Duke

    # The icon's Url.
    # Refer to https://docs.chocolatey.org/en-us/create/create-packages#package-icon-guidelines
    #  
    iconUrl: https://rawcdn.githack.com/duke/app/0934fa1fa3f0bd09c0c8c39fbdeb5df2ce507457/icon.png

# 
[packagers.chocolatey]
  # Enables or disables Chocolatey.
  # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  # Defaults to `NEVER`.
  #  
  active = "ALWAYS"

  # Let the release continue if the packager fails.
  # Defaults to `false`.
  # 
  continueOnError = true

  # Custom download URL.
  #  
  downloadUrl = "https://my.server.com/{{projectName}}/{{tagName}}/{{artifactFile}}"

  # Additional properties used when evaluating templates.
  #  
  extraProperties.foo = "bar"
  # Key will be capitalized and prefixed with `chocolatey`, i.e, `chocolateyFoo`.

  # Directory with file templates used to prepare the Chocolatey distribution.
  # Defaults to `src/jreleaser/distributions/#{distribution.name}/chocolatey`.
  # If specified, path must exist.
  # 
  templateDirectory = "path/to/chocolatey/templates"

  # List of template files to be skipped.
  # Value may be an exact match or a regex.
  # 
  skipTemplates = [ "README.md.tpl" ]

  # Git author used to commit to the repository.

  # Name used when authoring commits.
  # Defaults to `jreleaserbot`.
  # 
  commitAuthor.name = "jreleaserbot"

  # E-mail used when authoring commits.
  # Defaults to `jreleaser@kordamp.org`.
  # 
  commitAuthor.email = "jreleaser@kordamp.org"

  # Git repository to push the manifest to.
  # Defaults are shown.

  # Enables or disables the bucket.
  # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  # Defaults to `RELEASE`.
  # 
  bucket.active = "ALWAYS"


  # The owner of the bucket.
  # Defaults to the same owner as the release repository.
  # 
  bucket.owner = "duke"

  # The name of the bucket.
  # Defaults to `chocolatey-bucket`.
  # 
  bucket.name = "chocolatey-bucket"

  # The tag associated with the manifest.
  # If left unspecified, will use `{{tagName}}`.
  #  
  bucket.tagName = "{{distributionName}}-{{tagName}}"

  # The target branch to pull from.
  # Defaults to the branch pointed by HEAD.
  #  
  bucket.branch = "HEAD"

  # The target branch to push to.
  # Defaults to the branch pointed by `#{branch}`.
  #    
  bucket.branchPush = "{{projectName}}-{{tagName}}"

  # Username used for authoring commits.
  # Must have write access to the bucket.
  # Defaults to the same username as the release repository.
  #  
  bucket.username = "duke"

  # Password or OAuth token with write access to the bucket.
  #  
  bucket.token = "__USE_ENVIRONMENT_VARIABLE__"

  # Message when committing to the bucket.
  # If left unspecified, `{{distributionName}} {{tagName}}` will be used.
  #  
  bucket.commitMessage = "{{distributionName}} {{tagName}}"

  # Name of the Chocolatey package.
  # Defaults to `#{distribution.name}`.
  # 
  packageName = "app"

  # Package version.
  # Defaults to `{{projectVersion}}`.
  #  
  packageVersion = "1.2.3"

  # The username that can publish Chocolatey packages.
  # If left unspecified, the release owner will be used.
  # 
  username = "duke"

  # The ApiKey associated with the given account.
  #  
  apiKey = "__USE_ENVIRONMENT_VARIABLE__"

  # The source to push the package to.
  # If left unspecified, will use `https://push.chocolatey.org/`.
  # 
  source = "https://push.chocolatey.org/"

  # Whether to build the package on a remote server or locally.
  # Defaults to `false`.
  # 
  remoteBuild = false

  # The title of the spec.
  # If left unspecified, will use `#{project.name}`.
  # 
  title = "Duke"

  # The icon's Url.
  # Refer to https://docs.chocolatey.org/en-us/create/create-packages#package-icon-guidelines
  #  
  iconUrl = "https://rawcdn.githack.com/duke/app/0934fa1fa3f0bd09c0c8c39fbdeb5df2ce507457/icon.png"

{
  // 
  "packagers": {
    // 
    "chocolatey": {
      // Enables or disables Chocolatey.
      // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      // Defaults to `NEVER`.
      //  
      "active": "ALWAYS",

      // Let the release continue if the packager fails.
      // Defaults to `false`.
      // 
      "continueOnError": true,

      // Custom download URL.
      //  
      "downloadUrl": "https://my.server.com/{{projectName}}/{{tagName}}/{{artifactFile}}",

      // Additional properties used when evaluating templates.
      //  
      "extraProperties": {
        // Key will be capitalized and prefixed with `chocolatey`, i.e, `chocolateyFoo`.
        "foo": "bar"
      },

      // Directory with file templates used to prepare the Chocolatey distribution.
      // Defaults to `src/jreleaser/distributions/#{distribution.name}/chocolatey`.
      // If specified, path must exist.
      // 
      "templateDirectory": "path/to/chocolatey/templates",

      // List of template files to be skipped.
      // Value may be an exact match or a regex.
      // 
      "skipTemplates": [
        "README.md.tpl"
      ],

      // Git author used to commit to the repository.
      // 
      "commitAuthor": {
        // Name used when authoring commits.
        // Defaults to `jreleaserbot`.
        // 
        "name": "jreleaserbot",

        // E-mail used when authoring commits.
        // Defaults to `jreleaser@kordamp.org`.
        // 
        "email": "jreleaser@kordamp.org"
      },

      // Git repository to push the manifest to.
      // Defaults are shown.
      // 
      "bucket": {
        // Enables or disables the bucket.
        // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        // Defaults to `RELEASE`.
        // 
        "active": "ALWAYS",


        // The owner of the bucket.
        // Defaults to the same owner as the release repository.
        // 
        "owner": "duke",

        // The name of the bucket.
        // Defaults to `chocolatey-bucket`.
        // 
        "name": "chocolatey-bucket",

        // The tag associated with the manifest.
        // If left unspecified, will use `{{tagName}}`.
        //  
        "tagName": "{{distributionName}}-{{tagName}}",

        // The target branch to pull from.
        // Defaults to the branch pointed by HEAD.
        //  
        "branch": "HEAD",

        // The target branch to push to.
        // Defaults to the branch pointed by `#{branch}`.
        //   
        "branchPush": "{{projectName}}-{{tagName}}",

        // Username used for authoring commits.
        // Must have write access to the bucket.
        // Defaults to the same username as the release repository.
        //  
        "username": "duke",

        // Password or OAuth token with write access to the bucket.
        //  
        "token": "__USE_ENVIRONMENT_VARIABLE__",

        // Message when committing to the bucket.
        // If left unspecified, `{{distributionName}} {{tagName}}` will be used.
        //  
        "commitMessage": "{{distributionName}} {{tagName}}"
      },

      // Name of the Chocolatey package.
      // Defaults to `#{distribution.name}`.
      // 
      "packageName": "app",

      // Package version.
      // Defaults to `{{projectVersion}}`.
      //  
      "packageVersion": "1.2.3",

      // The username that can publish Chocolatey packages.
      // If left unspecified, the release owner will be used.
      // 
      "username": "duke",

      // The ApiKey associated with the given account.
      //  
      "apiKey": "__USE_ENVIRONMENT_VARIABLE__",

      // The source to push the package to.
      // If left unspecified, will use `https://push.chocolatey.org/`.
      // 
      "source": "https://push.chocolatey.org/",

      // Whether to build the package on a remote server or locally.
      // Defaults to `false`.
      // 
      "remoteBuild": false,

      // The title of the spec.
      // If left unspecified, will use `#{project.name}`.
      // 
      "title": "Duke",

      // The icon's Url.
      // Refer to https://docs.chocolatey.org/en-us/create/create-packages#package-icon-guidelines
      //  
      "iconUrl": "https://rawcdn.githack.com/duke/app/0934fa1fa3f0bd09c0c8c39fbdeb5df2ce507457/icon.png"
    }
  }
}

<jreleaser>
  <!--
    
  -->
  <packagers>
    <!--
      
    -->
    <chocolatey>
      <!--
        Enables or disables Chocolatey.
        Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        Defaults to `NEVER`.
         
      -->
      <active>ALWAYS</active>

      <!--
        Let the release continue if the packager fails.
        Defaults to `false`.
        
      -->
      <continueOnError>true</continueOnError>

      <!--
        Custom download URL.
         
      -->
      <downloadUrl>https://my.server.com/{{projectName}}/{{tagName}}/{{artifactFile}}</downloadUrl>

      <!--
        Additional properties used when evaluating templates.
         
      -->
      <extraProperties>
        <!--
          Key will be capitalized and prefixed with `chocolatey`, i.e, `chocolateyFoo`.
        -->
        <foo>bar</foo>
      </extraProperties>

      <!--
        Directory with file templates used to prepare the Chocolatey distribution.
        Defaults to `src/jreleaser/distributions/#{distribution.name}/chocolatey`.
        If specified, path must exist.
        
      -->
      <templateDirectory>path/to/chocolatey/templates</templateDirectory>

      <!--
        List of template files to be skipped.
        Value may be an exact match or a regex.
        
      -->
      <skipTemplates>
        <skipTemplate>README.md.tpl</skipTemplate>
      </skipTemplates>

      <!--
        Git author used to commit to the repository.
        
      -->
      <commitAuthor>

        <!--
           Name used when authoring commits.
          Defaults to `jreleaserbot`.
          
        -->
        <name>jreleaserbot</name>

        <!--
          E-mail used when authoring commits.
          Defaults to `jreleaser@kordamp.org`.
          
        -->
        <email>jreleaser@kordamp.org</email>
      </commitAuthor>

      <!--
        Git repository to push the manifest to.
        Defaults are shown.
        
      -->
      <bucket>
        <!--
          Enables or disables the bucket.
          Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
          Defaults to `RELEASE`.
          
        -->
        <active>ALWAYS</active>


        <!--
          The owner of the bucket.
          Defaults to the same owner as the release repository.
          
        -->
        <owner>duke</owner>

        <!--
          The name of the bucket.
          Defaults to `chocolatey-bucket`.
          
        -->
        <name>chocolatey-bucket</name>

        <!--
          The tag associated with the manifest.
          If left unspecified, will use `{{tagName}}`.
           
        -->
        <tagName>{{distributionName}}-{{tagName}}</tagName>

        <!--
          The target branch to pull from.
          Defaults to the branch pointed by HEAD.
           
        -->
        <branch>HEAD</branch>

        <!--
          The target branch to push to.
          Defaults to the branch pointed by `#{branch}`.
            
        -->
        <branchPush>{{projectName}}-{{tagName}}</branchPush>

        <!--
          Username used for authoring commits.
          Must have write access to the bucket.
          Defaults to the same username as the release repository.
           
        -->
        <username>duke</username>

        <!--
          Password or OAuth token with write access to the bucket.
           
        -->
        <token>__USE_ENVIRONMENT_VARIABLE__</token>

        <!--
          Message when committing to the bucket.
          If left unspecified, `{{distributionName}} {{tagName}}` will be used.
           
        -->
        <commitMessage>{{distributionName}} {{tagName}}</commitMessage>
      </bucket>

      <!--
        Name of the Chocolatey package.
        Defaults to `#{distribution.name}`.
        
      -->
      <packageName>app</packageName>

      <!--
        Package version.
        Defaults to `{{projectVersion}}`.
         
      -->
      <packageVersion>1.2.3</packageVersion>

      <!--
        The username that can publish Chocolatey packages.
        If left unspecified, the release owner will be used.
        
      -->
      <username>duke</username>

      <!--
        The ApiKey associated with the given account.
         
      -->
      <apiKey>__USE_ENVIRONMENT_VARIABLE__</apiKey>

      <!--
        The source to push the package to.
        If left unspecified, will use `https://push.chocolatey.org/`.
        
      -->
      <source>https://push.chocolatey.org/</source>

      <!--
        Whether to build the package on a remote server or locally.
        Defaults to `false`.
        
      -->
      <remoteBuild>false</remoteBuild>

      <!--
        The title of the spec.
        If left unspecified, will use `#{project.name}`.
        
      -->
      <title>Duke</title>

      <!--
        The icon's Url.
        Refer to https://docs.chocolatey.org/en-us/create/create-packages#package-icon-guidelines
         
      -->
      <iconUrl>https://rawcdn.githack.com/duke/app/0934fa1fa3f0bd09c0c8c39fbdeb5df2ce507457/icon.png</iconUrl>
    </chocolatey>
  </packagers>
</jreleaser>

jreleaser {
  // 
  packagers {
    // 
    chocolatey {
      // Enables or disables Chocolatey.
      // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      // Defaults to `NEVER`.
      //  
      active = 'ALWAYS'

      // Let the release continue if the packager fails.
      // Defaults to `false`.
      // 
      continueOnError = true

      // Custom download URL.
      //  
      downloadUrl = 'https://my.server.com/{{projectName}}/{{tagName}}/{{artifactFile}}'

      // Additional properties used when evaluating templates.
      // Key will be capitalized and prefixed with `chocolatey`, i.e, `chocolateyFoo`.
      //  
      extraProperties.put('foo', 'bar')

      // Directory with file templates used to prepare the Chocolatey distribution.
      // Defaults to `src/jreleaser/distributions/#{distribution.name}/chocolatey`.
      // If specified, path must exist.
      // 
      templateDirectory = 'path/to/chocolatey/templates'

      // List of template files to be skipped.
      // Value may be an exact match or a regex.
      // 
      skipTemplate('README.md.tpl')

      // Git author used to commit to the repository.
      // 
      commitAuthor {
        // Name used when authoring commits.
        // Defaults to `jreleaserbot`.
        // 
        name = 'jreleaserbot'

        // E-mail used when authoring commits.
        // Defaults to `jreleaser@kordamp.org`.
        // 
        email = 'jreleaser@kordamp.org'
      }

      // Git repository to push the manifest to.
      // Defaults are shown.
      // 
      bucket {
        // Enables or disables the bucket.
        // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        // Defaults to `RELEASE`.
        // 
        active = 'ALWAYS'


        // The owner of the bucket.
        // Defaults to the same owner as the release repository.
        // 
        repoOwner = 'duke'

        // The name of the bucket.
        // Defaults to `chocolatey-bucket`.
        // 
        name = 'chocolatey-bucket'

        // The tag associated with the manifest.
        // If left unspecified, will use `{{tagName}}`.
        //  
        tagName = '{{distributionName}}-{{tagName}}'

        // The target branch to pull from.
        // Defaults to the branch pointed by HEAD.
        //  
        branch = 'HEAD'

        // The target branch to push to.
        // Defaults to the branch pointed by `#{branch}`.
        //   
        branchPush = '{{projectName}}-{{tagName}}'

        // Username used for authoring commits.
        // Must have write access to the bucket.
        // Defaults to the same username as the release repository.
        //  
        username = 'duke'

        // Password or OAuth token with write access to the bucket.
        //  
        token = '__USE_ENVIRONMENT_VARIABLE__'

        # Message when committing to the bucket.
        # If left unspecified, `{{distributionName}} {{tagName}}` will be used.
        #  
        commitMessage = '{{distributionName}} {{tagName}}'
      }

      // Name of the Chocolatey package.
      // Defaults to `#{distribution.name}`.
      // 
      packageName = 'app'

      // Package version.
      // Defaults to `{{projectVersion}}`.
      //  
      packageVersion = '1.2.3'

      // The username that can publish Chocolatey packages.
      // If left unspecified, the release owner will be used.
      // 
      username = 'duke'

      // The ApiKey associated with the given account.
      //  
      apiKey = '__USE_ENVIRONMENT_VARIABLE__'

      // The source to push the package to.
      // If left unspecified, will use `https://push.chocolatey.org/`.
      // 
      source = 'https://push.chocolatey.org/'

      // Whether to build the package on a remote server or locally.
      // Defaults to `false`.
      // 
      remoteBuild = false

      // The title of the spec.
      // If left unspecified, will use `#{project.name}`.
      // 
      title = 'Duke'

      // The icon's Url.
      // Refer to https://docs.chocolatey.org/en-us/create/create-packages#package-icon-guidelines
      //  
      iconUrl = 'https://rawcdn.githack.com/duke/app/0934fa1fa3f0bd09c0c8c39fbdeb5df2ce507457/icon.png'
    }
  }
}

Environment

When not explicitly set, the value of the following properties may be resolved from an environment variable or a system property as shown in the table. The system property takes precedence over the environment variable.

Inside packagers section

System Property	Environment Variable
active
jreleaser.packagers.chocolatey.active	JRELEASER_PACKAGERS_CHOCOLATEY_ACTIVE

System Property

Environment Variable

active

jreleaser.packagers.chocolatey.active

JRELEASER_PACKAGERS_CHOCOLATEY_ACTIVE

Inside distributions section

System Property	Environment Variable
active
jreleaser.distributions.${name}.chocolatey.active	JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_ACTIVE
apiKey
jreleaser.distributions.${name}.chocolatey.api.key jreleaser.chocolatey.api.key	JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_API_KEY JRELEASER_CHOCOLATEY_API_KEY
bucket.active
jreleaser.distributions.${name}.chocolatey.bucket.active	JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_BUCKET_ACTIVE
bucket.username
jreleaser.distributions.${name}.chocolatey.bucket.username jreleaser.chocolatey.github.username jreleaser.chocolatey.gitlab.username jreleaser.chocolatey.gitea.username jreleaser.chocolatey.codeberg.username jreleaser.github.username jreleaser.gitlab.username jreleaser.gitea.username jreleaser.codeberg.username	JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_BUCKET_USERNAME JRELEASER_CHOCOLATEY_GITHUB_USERNAME JRELEASER_CHOCOLATEY_GITLAB_USERNAME JRELEASER_CHOCOLATEY_GITEA_USERNAME JRELEASER_CHOCOLATEY_CODEBERG_USERNAME JRELEASER_GITHUB_USERNAME JRELEASER_GITLAB_USERNAME JRELEASER_GITEA_USERNAME JRELEASER_CODEBERG_USERNAME
bucket.token
jreleaser.distributions.${name}.chocolatey.bucket.token jreleaser.chocolatey.github.token jreleaser.chocolatey.gitlab.token jreleaser.chocolatey.gitea.token jreleaser.chocolatey.codeberg.token jreleaser.github.token jreleaser.gitlab.token jreleaser.gitea.token jreleaser.codeberg.token	JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_BUCKET_TOKEN JRELEASER_CHOCOLATEY_GITHUB_TOKEN JRELEASER_CHOCOLATEY_GITLAB_TOKEN JRELEASER_CHOCOLATEY_GITEA_TOKEN JRELEASER_CHOCOLATEY_CODEBERG_TOKEN JRELEASER_GITHUB_TOKEN JRELEASER_GITLAB_TOKEN JRELEASER_GITEA_TOKEN JRELEASER_CODEBERG_TOKEN
bucket.branch
jreleaser.distributions.${name}.chocolatey.bucket.branch jreleaser.chocolatey.github.branch jreleaser.chocolatey.gitlab.branch jreleaser.chocolatey.gitea.branch jreleaser.chocolatey.codeberg.branch jreleaser.github.branch jreleaser.gitlab.branch jreleaser.gitea.branch jreleaser.codeberg.branch	JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_BUCKET_BRANCH JRELEASER_CHOCOLATEY_GITHUB_BRANCH JRELEASER_CHOCOLATEY_GITLAB_BRANCH JRELEASER_CHOCOLATEY_GITEA_BRANCH JRELEASER_CHOCOLATEY_CODEBERG_BRANCH JRELEASER_GITHUB_BRANCH JRELEASER_GITLAB_BRANCH JRELEASER_GITEA_BRANCH JRELEASER_CODEBERG_BRANCH
bucket.branchPush
jreleaser.distributions.${name}.chocolatey.bucket.branch.push jreleaser.chocolatey.github.branch.push jreleaser.chocolatey.gitlab.branch.push jreleaser.chocolatey.gitea.branch.push jreleaser.chocolatey.codeberg.branch.push jreleaser.github.branch.push jreleaser.gitlab.branch.push jreleaser.gitea.branch.push jreleaser.codeberg.branch.push	JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_BUCKET_BRANCH_PUSH JRELEASER_CHOCOLATEY_GITHUB_BRANCH_PUSH JRELEASER_CHOCOLATEY_GITLAB_BRANCH_PUSH JRELEASER_CHOCOLATEY_GITEA_BRANCH_PUSH JRELEASER_CHOCOLATEY_CODEBERG_BRANCH_PUSH JRELEASER_GITHUB_BRANCH_PUSH JRELEASER_GITLAB_BRANCH_PUSH JRELEASER_GITEA_BRANCH_PUSH JRELEASER_CODEBERG_BRANCH_PUSH

System Property

Environment Variable

active

jreleaser.distributions.${name}.chocolatey.active

JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_ACTIVE

apiKey

jreleaser.distributions.${name}.chocolatey.api.key
jreleaser.chocolatey.api.key

JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_API_KEY
JRELEASER_CHOCOLATEY_API_KEY

bucket.active

jreleaser.distributions.${name}.chocolatey.bucket.active

JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_BUCKET_ACTIVE

bucket.username

jreleaser.distributions.${name}.chocolatey.bucket.username
jreleaser.chocolatey.github.username
jreleaser.chocolatey.gitlab.username
jreleaser.chocolatey.gitea.username
jreleaser.chocolatey.codeberg.username
jreleaser.github.username
jreleaser.gitlab.username
jreleaser.gitea.username
jreleaser.codeberg.username

JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_BUCKET_USERNAME
JRELEASER_CHOCOLATEY_GITHUB_USERNAME
JRELEASER_CHOCOLATEY_GITLAB_USERNAME
JRELEASER_CHOCOLATEY_GITEA_USERNAME
JRELEASER_CHOCOLATEY_CODEBERG_USERNAME
JRELEASER_GITHUB_USERNAME
JRELEASER_GITLAB_USERNAME
JRELEASER_GITEA_USERNAME
JRELEASER_CODEBERG_USERNAME

bucket.token

jreleaser.distributions.${name}.chocolatey.bucket.token
jreleaser.chocolatey.github.token
jreleaser.chocolatey.gitlab.token
jreleaser.chocolatey.gitea.token
jreleaser.chocolatey.codeberg.token
jreleaser.github.token
jreleaser.gitlab.token
jreleaser.gitea.token
jreleaser.codeberg.token

JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_BUCKET_TOKEN
JRELEASER_CHOCOLATEY_GITHUB_TOKEN
JRELEASER_CHOCOLATEY_GITLAB_TOKEN
JRELEASER_CHOCOLATEY_GITEA_TOKEN
JRELEASER_CHOCOLATEY_CODEBERG_TOKEN
JRELEASER_GITHUB_TOKEN
JRELEASER_GITLAB_TOKEN
JRELEASER_GITEA_TOKEN
JRELEASER_CODEBERG_TOKEN

bucket.branch

jreleaser.distributions.${name}.chocolatey.bucket.branch
jreleaser.chocolatey.github.branch
jreleaser.chocolatey.gitlab.branch
jreleaser.chocolatey.gitea.branch
jreleaser.chocolatey.codeberg.branch
jreleaser.github.branch
jreleaser.gitlab.branch
jreleaser.gitea.branch
jreleaser.codeberg.branch

JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_BUCKET_BRANCH
JRELEASER_CHOCOLATEY_GITHUB_BRANCH
JRELEASER_CHOCOLATEY_GITLAB_BRANCH
JRELEASER_CHOCOLATEY_GITEA_BRANCH
JRELEASER_CHOCOLATEY_CODEBERG_BRANCH
JRELEASER_GITHUB_BRANCH
JRELEASER_GITLAB_BRANCH
JRELEASER_GITEA_BRANCH
JRELEASER_CODEBERG_BRANCH

bucket.branchPush

jreleaser.distributions.${name}.chocolatey.bucket.branch.push
jreleaser.chocolatey.github.branch.push
jreleaser.chocolatey.gitlab.branch.push
jreleaser.chocolatey.gitea.branch.push
jreleaser.chocolatey.codeberg.branch.push
jreleaser.github.branch.push
jreleaser.gitlab.branch.push
jreleaser.gitea.branch.push
jreleaser.codeberg.branch.push

JRELEASER_DISTRIBUTIONS_${name}_CHOCOLATEY_BUCKET_BRANCH_PUSH
JRELEASER_CHOCOLATEY_GITHUB_BRANCH_PUSH
JRELEASER_CHOCOLATEY_GITLAB_BRANCH_PUSH
JRELEASER_CHOCOLATEY_GITEA_BRANCH_PUSH
JRELEASER_CHOCOLATEY_CODEBERG_BRANCH_PUSH
JRELEASER_GITHUB_BRANCH_PUSH
JRELEASER_GITLAB_BRANCH_PUSH
JRELEASER_GITEA_BRANCH_PUSH
JRELEASER_CODEBERG_BRANCH_PUSH

Substitute ${name} for the value of the named instance.

Space (' '), underscore (_), and dash (-) will be replaced by dot (.) to separate tokens in the System property. Space (' '), dash (-), and dot (.) will be replaced by underscore (_) to separate tokens in the environment variable, such that:

${name} System Property Environment Variable

${name}	System Property	Environment Variable
foobar	`foobar`	`FOOBAR`
fooBar	`foobar`	`FOOBAR`
foo bar	`foo.bar`	`FOO_BAR`
foo-bar	`foo.bar`	`FOO_BAR`
foo_bar	`foo.bar`	`FOO_BAR`
foo.bar	`foo.bar`	`FOO_BAR`

foobar

foobar

FOOBAR

fooBar

foobar

FOOBAR

foo bar

foo.bar

FOO_BAR

foo-bar

foo.bar

FOO_BAR

foo_bar

foo.bar

FOO_BAR

foo.bar

foo.bar

FOO_BAR

Tokens

The bucket token environment variable must match with the chosen Release service.

On GitHub, you can’t use the default secrets.GITHUB_TOKEN as this token only works for the repository that’s running the workflow. You must configure a Personal Access Token (PAT) instead. It is recommended that you use "fine-grained" PATs, rather than "classic" ones. The token must have:

Access to your tap repository; if this repository is part of a GitHub organization, make sure to choose that organization as the resource owner; if that organization doesn’t show up in the "resource owner" drop-down, contact your organization adminstrator and ask them to enable PAT access for that repository
The "Contents read and write" repository permission

DownloadURL

JReleaser follows these rules to find the download URL to use for a given artifact:

if artifact.extraProperties.chocolateyDownloadUrl exists, use it.
if artifact.extraProperties.downloadUrl exists, use it.
if explicit downloadUrl is set on chocolatey, use it.
if distribution.extraProperties.chocolateyDownloadUrl exists, use it.
if distribution.extraProperties.downloadUrl exists, use it.
if releaser.${release}.skipRelease is false then use the releaser’s downloadUrl.
if releaser.${release}.skipRelease is true then look for a matching uploader given an extraProperty named downloadUrlFrom on artifact, distribution, `chocolatey (in that order). The value must be <uploaderType>:<uploaderName> such as "artifactory:app" or "s3:uploads".
fail if no suitable URL is found.

With no extra configuration from your side rule 6. will be chosen which is the suitable default that most projects need.

Example

Assuming the current version is 1.2.3, and a distribution named app, the above configuration will generate the following files which will be published to duke/chocolatey-bucket/app

app.nuspec

<?xml version="1.0" encoding="utf-8"?>
<!-- Do not remove this test for UTF-8: if “Ω” doesn’t appear as greek uppercase omega letter enclosed in quotation marks, you should use an editor that supports UTF-8, not this one. -->
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
  <metadata>
    <!-- required -->
    <id>app</id>
    <version>1.2.3</version>
    <authors>Duke</authors>
    <description>Sample app</description>
    <!-- optional -->
    <title>app</title>
    <projectUrl>https://acme.com/app</projectUrl>
    <copyright>2021 Duke</copyright>
    <licenseUrl>https://github.com/duke/app/blob/main/LICENSE</licenseUrl>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <tags>app</tags>
    <summary>Sample app</summary>
    <projectSourceUrl>https://github.com/duke/app</projectSourceUrl>
    <packageSourceUrl>https://github.com/duke/chocolatey-bucket</packageSourceUrl>
    <docsUrl>https://acme.com/app</docsUrl>
    <bugTrackerUrl>https://github.com/duke/app/issues</bugTrackerUrl>
    <iconUrl>https://rawcdn.githack.com/duke/app/0934fa1fa3f0bd09c0c8c39fbdeb5df2ce507457/icon.png</iconUrl>
    <releaseNotes>https://github.com/duke/app/releases/tag/v1.2.3</releaseNotes>
  </metadata>
  <files>
    <file src="tools\**" target="tools" />
  </files>
</package>

tools/chocolateyinstall.ps1

$tools = Split-Path $MyInvocation.MyCommand.Definition
$package = Split-Path $tools
$app_home = Join-Path $package 'app-1.2.3'
$app_bat = Join-Path $app_home 'bin/app.bat'

Install-ChocolateyZipPackage `
    -PackageName 'app' `
    -Url 'https://github.com/duke/app/releases/download/v1.2.3/app-1.2.3.zip' `
    -Checksum '812121a64bbd3f49286f7b0be3c9209068f71fcf9541f313708979602e8de466' `
    -ChecksumType 'sha256' `
    -UnzipLocation $package

Install-BinFile -Name 'app' -Path $app_bat

tools/chocolateyuninstall.ps1

$tools = Split-Path $MyInvocation.MyCommand.Definition
$package = Split-Path $tools
$app_home = Join-Path $package 'app-1.2.3'
$app_bat = Join-Path $app_home 'bin/app.bat'

Uninstall-BinFile -Name 'app' -Path $app_bat

Package Version

Be aware that Chocolatey imposes certain rules on package versions such as:

Up to 3 numeric elements separated by .
An optional tag separated by - from the numeric elements
If a 4th element is present separated by . it must be an integer or a number following the yyyyMMdd format.

Some examples of valid package versions are

1
1.2
1.2.3
1.2.3.4
1.2.3.20220731
1-ALPHA1
1.2-RC1
1.2.3-BETA

Remote Build

It’s expected that you take care of creating a nuget package and publish it to the desired location if remoteBuild is set to true. Templates for GitHub Actions will be available when the chosen releaser is GitHub.

The Push workflow triggers whenever a new tag is pushed to the bucket repository.
The Trigger workflow is triggered manually, use for the first publication or if the automatic workflow fails for some reason.

Templates

The default location for templates is:

src/jreleaser/distributions/<distribution-name>/chocolatey

The following list shows the filenames that may be used to override default templates:

binary.nuspec.tpl
tools/chocolateyinstall.ps1.tpl
tools/chocolateyuninstall.ps1.tpl
.github/workflows/push.yml.tpl
.github/workflows/trigger.yml.tpl

Any additional files found in the template directories will be copied as is unless their filename ends with .tpl in which case Name Templates substitution will take place.

Templates may be initialized using the template command

Skip Templates

You may skip any template files by defining a set of skip rules in the skipTemplates property. For example, you may use any of these expressions to skip a template named README.md.tpl:

README.md.tpl: matches the full template name
README.md: matches the transformed template name
README.*: matches using a regex

Skip Artifacts

If there is more than one matching artifact in a given distribution you may add a skipChocolatey extra property to the target artifact to mark it as skipped for packaging with chocolatey.

Skip License

If there’s a matching LICENSE file available at the root of the project it will be copied to the bucket by default. You may set an extra property named skipLicenseFile on chocolatey to skip this behavior.